Skip to content

Conversation

@lucydodo
Copy link
Member

@lucydodo lucydodo commented Oct 3, 2023

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! 😄

  • Changes
    • Add a CodeQL badge
    • Grouping badges by category
    • Remove 'Table of Contents' section
      • This feature was added via the New UI on GitHub. so I'm removing it.
    • Add guidance for 'continuous' build
    • Add a way to install the nightly version for macOS with SQLCipher support
    • Rename Twitter to X
    • A few readability improvements

You can see the changes in the following: https://github.com/sqlitebrowser/sqlitebrowser/tree/docs-refactor-readme

@lucydodo lucydodo self-assigned this Oct 3, 2023
@lucydodo lucydodo force-pushed the docs-refactor-readme branch from e49ee9b to e3e3a49 Compare October 3, 2023 00:58
@lucydodo lucydodo force-pushed the docs-refactor-readme branch from 39e0455 to 320199e Compare October 3, 2023 01:06
@justinclift
Copy link
Member

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.
Copy link
Member

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. 😄

@mgrojo
Copy link
Member

mgrojo commented Oct 11, 2023

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. 😄

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.

@justinclift
Copy link
Member

justinclift commented Oct 11, 2023

Ideally, GitHub should have a pragma to include an inline TOC ...

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:

WebAssembly
===========
:toc:
:toc-title:
:toclevels: 2
:icons:

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.

@lucydodo
Copy link
Member Author

Correct. I removed the TOC because, as @mgrojo said, GitHub added that feature.
To be honest, I often forget about that feature too (I don't think it's very accessible).

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?

@justinclift
Copy link
Member

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. 😄

@lucydodo lucydodo force-pushed the docs-refactor-readme branch from 9850303 to 80afe94 Compare October 12, 2023 09:51
@lucydodo
Copy link
Member Author

Added a TOC. Any thoughts on the postion of TOC?

Copy link
Member

@justinclift justinclift left a 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. 😄

@justinclift
Copy link
Member

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? 😄

@lucydodo
Copy link
Member Author

Sure, Go ahead! :)

@justinclift justinclift merged commit 4e1b5d5 into master Oct 12, 2023
@justinclift justinclift deleted the docs-refactor-readme branch October 12, 2023 13:36
@justinclift
Copy link
Member

Done. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants