Skip to content

Docs: Renovate #115

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
Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

Docs: Renovate #115

wants to merge 13 commits into from

Conversation

@Lunarnovaa
Copy link
Collaborator

@Lunarnovaa Lunarnovaa commented Jun 22, 2025 •
edited
Loading

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)
  • Syntax highlighting
  • 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

Opened new PR to allow for me to host the current version at rum.aurabora.org.

You can also see the modified readme/GitHub page at lunarnovaa/hjem-rum.

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 Lunarnovaa added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 22, 2025
@Lunarnovaa Lunarnovaa mentioned this pull request Jun 22, 2025
Closed
13 tasks
@a-usr
Copy link
Member

a-usr commented Jun 23, 2025

This seems slightly broken. Is this an issue on our end or on ndg's end?
image
image

@llakala
Copy link
Contributor

llakala commented Jun 23, 2025 •
edited
Loading

Is it possible to sort these better? Contributing: Introduction should definitely come first.
Screenshot_2025-06-23-16-28-09-43_3aea4af51f236e4932235fdada7d1643
Subsections would also be nice (Contributing vs Usage). Not sure if that's possible.

@Lunarnovaa
Copy link
Collaborator Author

This seems slightly broken. Is this an issue on our end or on ndg's end? image image

What looks broken in this?

@Lunarnovaa
Copy link
Collaborator Author

Is it possible to sort these better? Contributing: Introduction should definitely come first. Screenshot_2025-06-23-16-28-09-43_3aea4af51f236e4932235fdada7d1643 Subsections would also be nice (Contributing vs Usage). Not sure if that's possible.

This is an ndg issue, will be solved before this is marked ready for review.

@a-usr
Copy link
Member

a-usr commented Jun 25, 2025

What looks broken in this?

In the first image everything is normal, its the page you get after reloading. In the second Image I scrolled down, resulting in vanishing of the navbar

@Lunarnovaa Lunarnovaa force-pushed the renovate-docs-upstream branch 2 times, most recently from ae6f496 to 7c20efa Compare June 25, 2025 22:34
@Lunarnovaa Lunarnovaa force-pushed the renovate-docs-upstream branch 7 times, most recently from f3dde52 to e426001 Compare July 7, 2025 03:38
@nydragon nydragon mentioned this pull request Aug 27, 2025
Merged
6 tasks
@Lunarnovaa
meta: init docs testing workflow
1eeb35d
@Lunarnovaa
modules: fix descriptions
a2bdcfd 
desktops/hyprland: clarify file

programs/fish: prevent broken auto-linking
@Lunarnovaa
docs: init CNAME
9ce7525
@Lunarnovaa
docs: init footer
69a4e87
@Lunarnovaa
docs/package: cleanup
5ad485b
@Lunarnovaa
docs: minor improvements
a6f8dce 
docs: change option depth from 2->3

docs: init highlighting code

previously, code highlighting was not working upstreamed, but it is now
being worked on. this pr will not be merged until it is working
@Lunarnovaa
docs: fix footer formatting
670a389
@Lunarnovaa
docs: major renovation of all documenation
426d78a 
docs/README: move to .github/

docs/README: pare down to basic introduction

docs/README: init pronunciation info/helper

docs/README: init FAQ

docs/CONTRIBUTING: break into multiple files

docs/CONTRIBUTING: init DOCS

docs/USAGE: move usage README section into INSTALLATION and QUIRKS

docs: init informative pages on published site

docs: general rewriting, additions, and improvements

docs: add anchor links

docs/writing-modules: add info on nullable packages

docs/writing-modules: add dependence on config section

docs/installation: add info on configuring rum in hjem modules

docs/installation: add info on smfh
@Lunarnovaa
docs/README: fix éclairevoyant name
53c6c3a
@Lunarnovaa
docs: update ndg
d789033
@Lunarnovaa
docs: init cc-by-nc-sa license
6b7a0e5 
docs/README: modify GPLv3 explanation + link(s)

docs/footer: add license info
@Lunarnovaa
docs/README: change links to fork
0ef3848
@Lunarnovaa Lunarnovaa force-pushed the renovate-docs-upstream branch from e426001 to d4c4e31 Compare September 19, 2025 01:46
@a-usr
Copy link
Member

a-usr commented Sep 19, 2025

I got a notification that someone commented on a commit, but that commit is gone, so I cant see it. What did they say?

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

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Lunarnovaa @a-usr @llakala