Skip to content

docs: add DocC landing page for FerrostarCore#928

Open
NAKKA-POOJITHA wants to merge 2 commits into
stadiamaps:mainfrom
NAKKA-POOJITHA:feat/apple-doc-landing-page
Open

docs: add DocC landing page for FerrostarCore#928
NAKKA-POOJITHA wants to merge 2 commits into
stadiamaps:mainfrom
NAKKA-POOJITHA:feat/apple-doc-landing-page

Conversation

@NAKKA-POOJITHA

Copy link
Copy Markdown
Contributor

This PR addresses part of #347 by introducing a dedicated DocC documentation landing page for the FerrostarCore framework target.

Changes

  • Added FerrostarCore.docc directory structure under apple/Sources/FerrostarCore/.
  • Created FerrostarCore.md providing a high-level architectural overview, core concepts, and links to the user guide using proper DocC symbol linking.

@ianthetechie

Copy link
Copy Markdown
Contributor

Thanks; this is a good start!

From the original issue:

Ideally we'd figure out how to make this mirror the iOS setup docs from the guide. Both use Markdown so this should be scriptable.

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.

@NAKKA-POOJITHA

Copy link
Copy Markdown
Contributor Author

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.

@ianthetechie

Copy link
Copy Markdown
Contributor

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).

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants