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 documentation to the project's repository #61

Open
oleg-nenashev opened this issue Apr 23, 2023 · 0 comments
Open

Move documentation to the project's repository #61

oleg-nenashev opened this issue Apr 23, 2023 · 0 comments
Labels
documentation Documentation

Comments

@oleg-nenashev
Copy link
Member

Summary

Currently we have duplication of docs between README and the project's website, and I doubt it would be good in the future. To avoid consistency issues, I would propose to follow the documentation-as-code approach and put all the image-specific documentation under the repository, and just have a bare minimum on the website. Later we can implmenet importing documentation from the repository to the website.

References

@oleg-nenashev oleg-nenashev added the documentation Documentation label Apr 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation
Projects
None yet
Development

No branches or pull requests

1 participant