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

Move README content into code as TypeDoc #50

Open
steveluscher opened this issue Jan 4, 2025 · 0 comments
Open

Move README content into code as TypeDoc #50

steveluscher opened this issue Jan 4, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@steveluscher
Copy link
Collaborator

steveluscher commented Jan 4, 2025

  • Familiarize yourself with TypeDoc Tags https://typedoc.org/documents/Tags.html
  • Preview the documentation by running pnpm turbo compile:ghpages --output-logs=errors-only and python3 -m http.server -d docs in a separate terminal
  • Upload the docs somewhere and attach the link to your PR (eg. upload a ZIP through https://app.netlify.com/)
  • Submit one or more PR per package
@steveluscher steveluscher added the enhancement New feature or request label Jan 4, 2025
steveluscher added a commit that referenced this issue Jan 4, 2025
steveluscher added a commit that referenced this issue Jan 4, 2025
steveluscher added a commit that referenced this issue Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant