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.

Sign up for GitHub

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

Jump to bottom

Generate official documentation with MkDocs #4

Open
8 of 10 tasks
bobleesj opened this issue Jun 27, 2024 · 0 comments
Open
8 of 10 tasks

Generate official documentation with MkDocs #4

bobleesj opened this issue Jun 27, 2024 · 0 comments
Assignees
@bobleesj
Labels
documentation Improvements or additions to documentation

Comments

@bobleesj
Copy link
Owner

bobleesj commented Jun 27, 2024 •
edited
Loading

Discussions to add:

  • Discuss CN method (best method vs. bad method image)
  • Include software architecture (a diagram)
  • API documentation (generated with MkDocs and provide docstrings)
  • Include histogram generation
  • Discuss atomic mixing info (file-level, and pair-level)
  • Include preprocessing info (author removal, label replacement, loop values)

Format:

  • Modify color theme
  • Change favicon
  • Include Google Codelab link
  • Include how to modify the document
@bobleesj bobleesj added the documentation Improvements or additions to documentation label Jun 27, 2024
@bobleesj bobleesj self-assigned this Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bobleesj bobleesj

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bobleesj