-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
docs: Refactor README.md #3478
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: Refactor README.md #3478
Conversation
e49ee9b to
e3e3a49
Compare
39e0455 to
320199e
Compare
|
This looks decent, though I'm thinking we should keep the Table of Contents. That seems like it's probably useful because we have lots of sections. 😄 |
| DB Browser for SQLite works well on macOS. | ||
|
|
||
| * macOS 10.12 (Sierra) - 10.15 (Catalina) are tested and known to work. | ||
| * macOS 10.15 (Catalina) - 14.0 (Sonoma) are tested and known to work. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated & corrected macOS version numbers is good too. 😄
I think @lucydodo is removing it because you can display a TOC from the menu button. But I think that many people don't know that and will probably miss it. I knew that, but I always forget about it. Ideally, GitHub should have a pragma to include an inline TOC in the markdown document, but I looked for it and found nothing. |
Oh. That reminds me... Asciidoc (rather than Markdown) has that capability. For example, when the "WebAssembly" wiki page on the Go wiki became pretty long, I converted it from Markdown to Asciidoc specifically so it could autogenerate the ToC. The first few lines of that file (in raw text mode) are now: Which generates the Table of Contents seen here: https://github.com/golang/go/wiki/WebAssembly That being said, I'm not really a fan of Asciidoc otherwise. Markdown seems more natural (to me), though that's probably just a familiarity thing. |
|
Correct. I removed the TOC because, as @mgrojo said, GitHub added that feature. I don't mind adding it back because it doesn't make it less readable and it's not that hard, what do you think? |
|
I reckon we should add it back. That way it works for everyone that reads the page, and people don't have to know about special GitHub buttons. 😄 |
9850303 to
80afe94
Compare
|
Added a TOC. Any thoughts on the postion of TOC? |
justinclift
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks (really) good to me. 😄
|
Table of Contents placement looks good, and everything else seems fine too. Happy to merge this, unless there's other stuff that needs doing to it? 😄 |
|
Sure, Go ahead! :) |
|
Done. 😄 |
I've made a few improvements to the README.md I'd like to get some feedback on these improvements, so I'm leaving a PR.
I'd be grateful if anyone would feel free to review it. Thanks! 😄
You can see the changes in the following: https://github.com/sqlitebrowser/sqlitebrowser/tree/docs-refactor-readme