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

Reorg README to be more user-friendly #951

Closed
jamesmaa opened this issue May 16, 2024 · 1 comment
Closed

Reorg README to be more user-friendly #951

jamesmaa opened this issue May 16, 2024 · 1 comment
Labels
area/documentation The issue or PR is about documentation

Comments

@jamesmaa
Copy link
Collaborator

jamesmaa commented May 16, 2024 •
edited

Some issues with the current reorg

  • the content "above-the-fold" is not relevant for users
image
  • I think we can remove the historical context or greatly simplify it
  • Remove the changes and enhancements bullet point or put it into contributing
  • Move contributing section to the bottom
  • Add bigger chrome and firefox buttons for installation
  • Move installation section to the top
  • Add table of supported languages per Add documentation for multilanguage support #947
@jamesmaa jamesmaa added the area/documentation The issue or PR is about documentation label May 16, 2024
@jamesmaa
Copy link
Collaborator Author

Mostly covered by #978

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation The issue or PR is about documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jamesmaa