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

Sync readme with docs #428

Merged
merged 2 commits into from
Oct 20, 2023
Merged

Sync readme with docs #428

merged 2 commits into from
Oct 20, 2023

Conversation

alan-cooney
Copy link
Collaborator

@alan-cooney alan-cooney commented Oct 19, 2023

Edit: Changed to just sync the docs with the readme (will move readme to another pr). An automated solution may be better here, but seems fine for now to just update the docs pages.

@alan-cooney alan-cooney marked this pull request as draft October 19, 2023 16:27
@neelnanda-io
Copy link
Collaborator

Hmm, I'm generally pro putting things in the README, since I don't think people will actually go and read the docs. The reason I have a gallery is to try to create credibility for "this library is actually used by real researchers", and the reason I have the tutorials is to nerd-snipe people who want to learn about mech interp, and IMO the README is something such people are likely to read. I'd be pro keeping them in

@alan-cooney
Copy link
Collaborator Author

Makes sense - for now I'll add a quick solution in so that the readme sections and their corresponding pages on the docs site are kept in sync.

In general my approach for starting to use a new lib is this:

  1. Skim the readme intro to understand what it does
  2. Do a few quick checks (e.g. check it's still maintained with recent commits, see if it seems robust)
  3. Skim the API docs to understand what functionality there is
  4. Use the Quick Start to get going and then mostly use code hints (from the docstrings) + the API docs pages.

My thinking is if we can support this flow, and encourage people to follow it, it will help people get to grips with the lib in a faster way. It's also nice for the user if all the important docs are in one place, and then tutorials can supplement this for specific use cases.

Btw I've been adding a bunch of PRs recently and merging (been discussing with @jbloomAus and @bryce13950 a bit behind the scenes as well). If you want to have more oversight into the direction of the docs let me know and I can mark more stuff for review instead.

@alan-cooney alan-cooney force-pushed the readme2 branch 2 times, most recently from cb8ee55 to 78a7df2 Compare October 20, 2023 12:45
@alan-cooney alan-cooney changed the title Simplify Readme Sync readme with docs Oct 20, 2023
@alan-cooney alan-cooney marked this pull request as ready for review October 20, 2023 12:50
@alan-cooney
Copy link
Collaborator Author

Hmm, I'm generally pro putting things in the README, since I don't think people will actually go and read the docs. The reason I have a gallery is to try to create credibility for "this library is actually used by real researchers", and the reason I have the tutorials is to nerd-snipe people who want to learn about mech interp, and IMO the README is something such people are likely to read. I'd be pro keeping them in

Switched for now to just sync the docs with the readme (which was more up to date). Will pull the other stuff into a separate PR.

@alan-cooney alan-cooney merged commit 3caad41 into main Oct 20, 2023
7 checks passed
@bryce13950 bryce13950 deleted the readme2 branch October 26, 2024 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants