Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FX-519] Auto-generate reference documentation #103

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

djoksimo
Copy link
Contributor

@djoksimo djoksimo commented Sep 11, 2023

What

  • Adds support for Jazzy reference documentation generator

Why

Test Plan

View docs here 👉🏻 https://clinquant-meringue-5947c5.netlify.app/

cd <path-to-ios-sdk-repo>

[sudo] gem install jazzy

jazzy # generate reference-docs/

open reference-docs/index.html # open the docs website locally

# can use services like Netlify Drop to quickly deploy to temporary website and share the new docs with others
  • ✅ Not a front-end change
  • Navigated through docs for all of the methods and members

How

  • Can be released as-is.
  • Will have a follow-up PR that automatically deploys the docs to github pages.

@djoksimo
Copy link
Contributor Author

djoksimo commented Sep 11, 2023

This stack of pull requests is managed by Graphite. Learn more about stacking.

@djoksimo djoksimo changed the title [FX-519] Can auto-generate reference documentation [FX-519] Auto-generate reference documentation Sep 15, 2023
@djoksimo djoksimo force-pushed the danilo/fx-519-generate-and-host-ios-mvp-reference-docs-using-xcode-tools branch from bb6bcc2 to 3d4aa32 Compare November 3, 2023 13:35
@djoksimo djoksimo force-pushed the danilo/fx-519-generate-and-host-ios-mvp-reference-docs-using-xcode-tools branch from 3d4aa32 to 153e189 Compare December 13, 2023 21:56
@devinmorgan
Copy link
Contributor

@djoksimo , this still a PR we want to ship? If so I'll review and test locally - lmk!

@djoksimo
Copy link
Contributor Author

@djoksimo , this still a PR we want to ship? If so I'll review and test locally - lmk!

@devinmorgan Yes, this PR should still work. We'll re-visit it when we have a new iOS platform/retailer in the late contract phase.

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