docs: add DocC landing page for FerrostarCore#928
Open
NAKKA-POOJITHA wants to merge 1 commit into
Open
Conversation
Contributor
|
Thanks; this is a good start! From the original issue:
I think that we do still need to do this. Though in retrospect maybe my original idea of using a script wasn't the best, since mdbook is more vanilla markdown formatting, and DooC has its own special way of doing links. So, I think we should probably rather try to move the iOS docs out of mdbook and over to here, and adapt the formatting / page structure as needed to Apple/DooC conventions. |
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
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 PR addresses part of #347 by introducing a dedicated DocC documentation landing page for the
FerrostarCoreframework target.Changes
FerrostarCore.doccdirectory structure underapple/Sources/FerrostarCore/.FerrostarCore.mdproviding a high-level architectural overview, core concepts, and links to the user guide using proper DocC symbol linking.