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

Migrate the documentation to a Wiki #321

Closed
9 tasks done
diego-aquino opened this issue Aug 11, 2024 · 1 comment · Fixed by #328
Closed
9 tasks done

Migrate the documentation to a Wiki #321

diego-aquino opened this issue Aug 11, 2024 · 1 comment · Fixed by #328
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@diego-aquino
Copy link
Member

diego-aquino commented Aug 11, 2024

Examples: https://github.com/MyHoneyBadger/awesome-github-wiki

  • Migrate detailed guides and API references from the README.md to the Wiki
  • Commit all wiki markdown files in the main repository
  • Create a GitHub Action to push the markdown files to the Wiki repository
  • Migrate links to work when publishing the wiki markdown files (action)
  • Change README.md to be more brief
  • Think about how to redirect the previous links to the new documentation
  • Mention typegen in the basic usage guide
  • Document all of the exported types in each API reference directory
  • Update all links in JSDoc comments to point to the new documentation
@diego-aquino diego-aquino converted this from a draft issue Aug 11, 2024
@diego-aquino diego-aquino self-assigned this Aug 11, 2024
@diego-aquino diego-aquino added the documentation Improvements or additions to documentation label Aug 11, 2024
@diego-aquino diego-aquino added this to the v0.9.0 milestone Aug 11, 2024
@diego-aquino diego-aquino moved this from To do to In progress in Zimic Aug 14, 2024
@diego-aquino diego-aquino moved this from In progress to In review in Zimic Aug 19, 2024
@github-project-automation github-project-automation bot moved this from In review to Done in Zimic Aug 19, 2024
Copy link
Contributor

Released in v0.9.0 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant