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

[Docs] /docs in repo should have a README.md that links to the docs #3870

Closed
rysweet opened this issue Oct 21, 2024 · 1 comment · Fixed by #4371
Closed

[Docs] /docs in repo should have a README.md that links to the docs #3870

rysweet opened this issue Oct 21, 2024 · 1 comment · Fixed by #4371
Assignees
Labels
documentation Improvements or additions to documentation size-small takes 1-2 days
Milestone

Comments

@rysweet
Copy link
Collaborator

rysweet commented Oct 21, 2024

What feature would you like to be added?

if browsing the repo there is a top level /docs dir that doesn't have much in it - we need at least a readme there that points to the preferred docs entry point.

Why is this needed?

should be super easy to find the docs

@jackgerrits
Copy link
Member

jackgerrits commented Oct 22, 2024

The main entrypoint is here:

Image

The plan is to repoint this to 0.4 once it is released

@jackgerrits jackgerrits added this to the 0.4 milestone Oct 22, 2024
@jackgerrits jackgerrits added the documentation Improvements or additions to documentation label Oct 22, 2024
@fniedtner fniedtner removed the feature label Oct 24, 2024
@jackgerrits jackgerrits added the size-small takes 1-2 days label Oct 24, 2024
@jackgerrits jackgerrits self-assigned this Nov 20, 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 size-small takes 1-2 days
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants