stytchauth / stytch-ios

MIT License
31 stars 5 forks source link

[SDK-2024] Fixing Broken Links in Documentation #307

Closed nidal-stytch closed 12 hours ago

nidal-stytch commented 23 hours ago

Linear Ticket: [SDK-2024] [iOS] Broken Links in docs homepage.

Changes:

  1. I finally realized that you can run "make docs" locally and that generates a StytchCore.doccarchive within the repo directory locally at: stytch-ios/.build/Build/Products/Release-iphoneos/StytchCore.doccarchive
  2. If you double click that file it will open in Xcode as a whole documentation set.
  3. If some of the links are broken that you define from the StytchCore.md from within Xcode, you must check their symbol.
  4. You will notice that the links hav something like: StytchClient/OAuth-swift.struct/ThirdParty/start(configuration:)-75pid but that last part for -75pid doesn't always autocomplete. But you can find that symbol.
  5. If you open stytch-ios/.build/Build/Products/Release-iphoneos/StytchCore.doccarchive/index/index.json you can find that symbol extension in there and append it to the text in StytchCore.md.

Checklist: