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

[website] document codebase #11

Open
duanwilliam opened this issue Apr 21, 2022 · 0 comments
Open

[website] document codebase #11

duanwilliam opened this issue Apr 21, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@duanwilliam
Copy link
Contributor

The pipeline for generating pages from Jupyter notebooks, and being able to extend it to generate pages for e.g. Markdown documents or anything else, is somewhat complex and not fully documented, making it difficult for new contributors to help. Every function should be properly documented, and an ARCHITECTURE.md or other document should be made describing how the codebase works.

@duanwilliam duanwilliam self-assigned this Apr 21, 2022
@duanwilliam duanwilliam added the documentation Improvements or additions to documentation label May 18, 2022
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
None yet
Development

No branches or pull requests

1 participant