docs: add DocC landing page for FerrostarCore#928
Conversation
|
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. |
|
I've moved the four iOS documentation files (ios-getting-started.md, swiftui-customization.md, ios-dynamic-island.md, and ios-carplay.md) directly out of the guide directory and into the FerrostarCore.docc bundle folder. I also set up FerrostarCore.md to act as the primary DocC landing page mapping to them using proper symbol/page links. |
|
Thanks! It looks like you didn't make any changes to the Guide 😅 There should still be an iOS entry in the menu, but it can be either a direct link (if mdbook supports that; I don't actually know offhand) or a simple placeholder page that says you can find the documentation on the Swift Package Index. For now, the link can go here: https://swiftpackageindex.com/stadiamaps/ferrostar. (There is a docs link but it's broken since we don't have this yet haha). |
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.