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

[Proposal] Documentation coverage and static documentation site #17

Open
Tracked by #18
dest1n1s opened this issue Jun 8, 2024 · 0 comments
Open
Tracked by #18

[Proposal] Documentation coverage and static documentation site #17

dest1n1s opened this issue Jun 8, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed high priority

Comments

@dest1n1s
Copy link
Collaborator

dest1n1s commented Jun 8, 2024

It is much easier for people (who may be new to mechanistic interpretability) to get started with detailed tutorial and documentation. Currently this project lacks documentation and comments in many modules. We should raise the documentation coverage, to ensure detailed explanation of every part of our library.

Furthermore, we should consider building a static documentation site with tools like MkDocs. This helps people get an overview of the usage of the library without actually downloading it.

@dest1n1s dest1n1s added help wanted Extra attention is needed high priority labels Jun 8, 2024
@dest1n1s dest1n1s added the documentation Improvements or additions to documentation label Jun 8, 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 help wanted Extra attention is needed high priority
Projects
None yet
Development

No branches or pull requests

1 participant