Docs reimagining#821
Draft
ktoso wants to merge 3 commits into
Draft
Conversation
ktoso
force-pushed
the
wip-docs-docc-revamp
branch
from
0990bf8 to
0ec643d
Compare
ktoso
force-pushed
the
wip-docs-docc-revamp
branch
from
0ec643d to
89dfa97
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This does a few things:
swift-java.configdocs and validate it upon CI runs.This does a few hacks since docc doesn't allow linking snippets from "other places" and they must be in Snippets/ but we do not want them there, we want them to be validated with tests in normal sample apps like today. So This does a symlinking trick to keep them accessible to docc, but keep them in the right places. This breaks syntax highlighting on them... I'm looking for solutions to this.
This also uses the fact that we now support non-Swift snippets, which I've contributed over here: swiftlang/swift-docc-plugin#120
We'll need to work more with docc to meet our requirements here, but this is already a huge improvement.
I'll be going over all the examples to make sure they all make sense and are complete etc.
The docs are MUCH improved with this and this is how it looks like: