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

Separate website for documentation #29

Open
tisoap opened this issue May 25, 2022 · 0 comments
Open

Separate website for documentation #29

tisoap opened this issue May 25, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation pinned This should not be closed by bots on inactivity

Comments

@tisoap
Copy link
Owner

tisoap commented May 25, 2022

As the library grows in API size, it becomes more difficult to read about the available options on the repository README. Ideally this library should have a seperate website for documentation, with separate pages for each option and live intractable examples, same as the React Flow docs. They mentioned in their blog post that they're using Docusaurus, will need to check it out.

Ideally the documentation should be all statically build, and I should be able to deploy it using gh-pages, to save on server and domain costs. The current GitHub page hosts the Storybook examples and tests, but they can be moved to a free tier on Chromatic.

@tisoap tisoap added documentation Improvements or additions to documentation pinned This should not be closed by bots on inactivity labels May 25, 2022
Repository owner locked and limited conversation to collaborators Jun 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation pinned This should not be closed by bots on inactivity
Projects
None yet
Development

No branches or pull requests

1 participant