Skip to content

doc: align module capitalization #1115

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

Merged
merged 7 commits into from
Apr 10, 2025

Conversation

Flameopathic
Copy link
Contributor

@Flameopathic Flameopathic commented Apr 6, 2025

changes:

  • adds required meta.name attribute
  • implements check for module documentation title matching module name
  • implements specific error for module metadata missing required attributes
  • adds meta.name attribute to all applicable meta files
  • NVF -> nvf and Nixvim -> NixVim
  • documents meta.name attribute

related: #1084

Things done

Notify maintainers

@Flameopathic Flameopathic force-pushed the doc/align-module-capitalization branch 4 times, most recently from 82d91eb to b174420 Compare April 6, 2025 15:09
@Flameopathic Flameopathic force-pushed the doc/align-module-capitalization branch 2 times, most recently from 13ae07d to c45c759 Compare April 7, 2025 00:51
@Flameopathic Flameopathic force-pushed the doc/align-module-capitalization branch from f04195e to 097a68a Compare April 7, 2025 01:00
@Flameopathic Flameopathic marked this pull request as ready for review April 7, 2025 01:01
@Flameopathic
Copy link
Contributor Author

as an aside, we should consider breaking docs/default.nix into multiple files. as it stands, it is unwieldy and difficult to read.

Copy link
Collaborator

@trueNAHO trueNAHO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall approach LGTM.

Co-authored-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
@Flameopathic Flameopathic force-pushed the doc/align-module-capitalization branch from eec3ff4 to 4a51deb Compare April 8, 2025 11:57
@Flameopathic Flameopathic requested a review from trueNAHO April 8, 2025 12:54
@danth
Copy link
Owner

danth commented Apr 8, 2025

The way the index works means the links in the sidebar are sorted into alphabetical order based on the module slug: it would be nice to change that to use the human readable name at some point. Not necessary in this PR though.

Flameopathic and others added 2 commits April 8, 2025 12:48
Co-authored-by: Daniel Thwaites <danth@danth.me>
Copy link
Collaborator

@awwpotato awwpotato left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@trueNAHO trueNAHO enabled auto-merge (squash) April 10, 2025 06:45
@trueNAHO trueNAHO merged commit 82f67a3 into danth:master Apr 10, 2025
4 checks passed
trueNAHO added a commit to Mrbroggle/stylix that referenced this pull request Apr 10, 2025
Add required meta.name attribute as of commit 82f67a3 ("doc: align
module capitalization (danth#1115)").
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants