Skip to content

Conversation

@maxinelasp
Copy link
Contributor

I wrote this how-to page for Libera, and thought it could be useful to establish some guidelines in this dev guide as well.

@maxinelasp maxinelasp requested review from kjbrooks and mmaclay January 9, 2026 21:27
@maxinelasp
Copy link
Contributor Author

Are there specific people that should be tagged for a review? I just added a few random people I knew worked on this dev guide.

@maxinelasp
Copy link
Contributor Author

The pre-commit checker for markdown lint was giving me major trouble when installing, so I removed it

@mmaclay
Copy link
Collaborator

mmaclay commented Jan 12, 2026

Strange! Do you think there is a version issue with the pre-commit markdown linter? Or any ideas what was wrong based on error messages?

Thanks for adding this content - looks great!

@maxinelasp
Copy link
Contributor Author

Do you think there is a version issue with the pre-commit markdown linter

It was a ruby install issue - I tried to fix it for a while, but ultimately, if I was having that many issues with it, someone else would have too, so I don't think it's worth it.

@mmaclay
Copy link
Collaborator

mmaclay commented Jan 12, 2026

The only change you might want to make is addressing that your page is kind of orphaned right now off of the root folder, but without displaying in the page tree.

  • I'd suggest that we could add another folder to our very short list of folders (i.e. workflows, programming languages etc) maybe called "Contributing" or "Writing Documentation" or "Getting Started with this Guide"

OR you could put your page just at the Home Level directory as a file, or in an existing folder.

You just have to edit the index.rst I think to show your page in the file tree.

Copy link
Collaborator

@mmaclay mmaclay left a comment

Choose a reason for hiding this comment

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

Add your page to an index.rst in order to have it show up in the file tree. Otherwise looks great!

@maxinelasp maxinelasp merged commit 7498709 into lasp:main Jan 12, 2026
8 checks passed
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.

2 participants