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

DEV/UI: consider removing README.md and pointing to the documentation site #15

Open
jwdevantier opened this issue Jul 3, 2023 · 1 comment
Open

DEV/UI: consider removing README.md and pointing to the documentation site #15

jwdevantier opened this issue Jul 3, 2023 · 1 comment

Comments

@jwdevantier
Copy link
Collaborator

README.md will always be a poor substitute for reading the documentation.
However, reading the raw RST files is not particularly user-friendly - so let's point the user toward the github page.
@safl
Copy link
Collaborator

safl commented Jul 5, 2023 •
edited
Loading

Agree, here are some additional considerations:

  • It should provide a decent GitHUB Landing page (primary use now)
  • Could be made re-usable in PyPI package descriptions
  • Could be made re-usable for the sphinx-doc landing page
  • Could contain misc. badges (pypi, docs, ci, docker images)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@safl @jwdevantier