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

Integrated Developer Documentation Hosting #65

Open
iMuFeng opened this issue Apr 24, 2024 Discussed in #62 · 0 comments
Open

Integrated Developer Documentation Hosting #65

iMuFeng opened this issue Apr 24, 2024 Discussed in #62 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@iMuFeng
Copy link
Contributor

iMuFeng commented Apr 24, 2024

Discussed in https://github.com/orgs/heyform/discussions/62

Originally posted by builtcuriously April 21, 2024
The ability to host and manage the developer documentation directly within the HeyForm repository would allow self-hosters and contributors to create, update, and access documentation alongside the codebase.

Benefits

  • locally accessibility
  • versioned to last sync to origin
  • community contributions

Implementation Suggestion

A separate directory within the monorepo such as /packages/docs. The existing docs are in Notion markdown and thus formatted appropriately.

Thank you for considering this suggestion ☺️

@iMuFeng iMuFeng added the documentation Improvements or additions to documentation label Apr 24, 2024
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: WIP
Development

No branches or pull requests

1 participant