Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Of Interest: docc support #1154

Open
thomasvl opened this issue Jun 17, 2021 · 5 comments
Open

Of Interest: docc support #1154

thomasvl opened this issue Jun 17, 2021 · 5 comments
Assignees
@tbkka

Comments

@thomasvl
Copy link
Collaborator

At WWDC2021 docc got announced. The current Makefile has some jazzy support, but might be time to revisit docs flows to instead look at building out docc support instead.

Things that might be needed:

  • tweak comments to use code references that link `SYMBOL` to ``SYMBOL``
  • Move some of the Documentation/ pages into things included in the built doc set output instead
  • Group/categories pages, etc. (see the WWDC videos for improving ones docs).
@jeroenleenarts
Copy link
Contributor

It would be cool if a manifest is added triggering Swift Package Index DocC generation. More info here.

@thomasvl
Copy link
Collaborator Author

thomasvl commented Jul 6, 2022

I believe they've removed the need for an entry in the Package.swift and all it takes is a .spi.yml entry. That would be fine my me, I was trying to get some time to try generating the docs manually and see if anything needed tweaking before adding the entry, but if you're interested, I'd say go for it!

@jeroenleenarts
Copy link
Contributor

All bits seem to be in place. So I'll ask on the SPI side of things.

@jeroenleenarts jeroenleenarts mentioned this issue Jul 6, 2022
Merged
@thomasvl thomasvl mentioned this issue Aug 2, 2022
Merged
@tbkka tbkka self-assigned this Aug 2, 2022
@thomasvl
Copy link
Collaborator Author

thomasvl commented Sep 9, 2022

@tbkka is there anything we can do on CI or manually to validate how we'll we've got things documented? i.e. - missing docs, apis missing params/return result docs/etc.

@thomasvl
Copy link
Collaborator Author

@tbkka should this stay open or get moved to more specific issues for what needs followup?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tbkka tbkka

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jeroenleenarts @thomasvl @tbkka