Renovate the docs

[Lunarnovaa]

General PR to address some current issues of the docs. Namely:

• Improve general cohesion of documentation
• Add documentation to our docs page
• Fix the custom link (CNAME)
• See if I can mess with CSS to add syntax highlighting and maybe change up the color scheme to be more individual to HJR
• Clean up the docs more generally, unify tone and such
• Break up CONTRIBUTING.md into multiple smaller files that link together (and modify the sidebar to make this cleaner)
• Add a simple index.md landing page

Current Blockers:

• New SNUG website domain
• NDG additive stylesheet option

Meta

Related Issue: #73

AI used to generate code included in this PR?: No

All Submissions:

• Formatted commit message in accordance with CONTRIBUTING.md guidelines
• Filled in all meta items
• Mentioned any blockers before the PR can merge
• Verified there are no conflicting PRs open

[Lunarnovaa]

The stylesheet additions will be in another PR so that we can get the CNAME and docs structure changes mergedb.

[a-usr]

Imo CNAME should be put in its own file under the docs dir for easy visibility, just like what I did. If you change that I'd be happy to close my own pr (unless you already did)

[Lunarnovaa]

Imo CNAME should be put in its own file under the docs dir for easy visibility, just like what I did. If you change that I'd be happy to close my own pr (unless you already did)

I'm not sure how it helps readability, especially since it just adds another file in the directory for a single line of text

[nezia1]

Fantastic work. LGTM, added a review comment but non blocking

[a-usr]

I'm not sure how it helps readability, especially since it just adds another file in the directory for a single line of text

Not readability, visibility. The difference is, if anyone tries to change the domain in the future, for any reason, and runs into the issue that the CNAME gets changed each doc workflow run for no apparent reason, a file is way easier to find than a single line of text

[Lunarnovaa]

• Moved CNAME to own file
• Moved markdown files to docs/manual
• Small cleanup/refactor

[Lunarnovaa]

Adding a couple more things.

[Lunarnovaa]

Addressed nezia's request and added a workflow to test build the docs. Please give feedback on the workflow, I'm pretty unfamiliar with them.

[nezia1]

One last question, but LGTM otherwise. The section on defaultText is really good stuff :)

[nezia1]

Don't we build docs already in the deployment workflow? The workflow would fail anyways if it was not able to be built, so I'm unsure if we really need this

[Lunarnovaa]

That occurs on merge. This workflow is a test workflow. So it's the difference between building the docs when a PR is opened to make sure it doesn't break anything, and building the docs after the PR is merged when it's either gonna break it or not.

[Lunarnovaa]

• Docs check workflow no longer runs if only tests were changed
• Example test is now nushell, not ncmpcpp
• Added link checking to the docs check workflow

[Lunarnovaa]

The 29 errors on the link checker workflow is a bug with ndg atm, should be fine on our actual docs.

[nezia1]

LGTM, but holding my review until ndg's bug is fixed

[Lunarnovaa]

LGTM, but holding my review until ndg's bug is fixed

I might just export the template and try to modify things myself.

[Lunarnovaa]

Alright, so the errors aren't a bug perse with ndg, rather, it's due to the javascript that adds anchors to headings not actually running at buildtime, even though it totally works fine on the published site. So, I've added anchors to the headings manually, and updated CONTRIBUTING to reflect that.

What's left I want to do:

• See if I can mess with CSS to add syntax highlighting and maybe change up the color scheme to be more individual to HJR
• Clean up the docs more generally, unify tone and such
• Break up CONTRIBUTING.md into multiple smaller files that link together (and modify the sidebar to make this cleaner)
• Add a simple index.md landing page

[Lunarnovaa]

Superseded by #115.