Add contributor docs and clean up boilerplate - #49
Merged
Conversation
- Replace the default Fumadocs README with one describing the project, repo layout, local dev, and CI checks - Add CONTRIBUTING.md covering workflow, checks, and writing guidelines - Remove leftover Fumadocs demo page (test.mdx) - Restore missing intro sentence on the getting-started guide
IzioDev
requested changes
Jun 20, 2026
IzioDev
left a comment
IzioDev
left a comment
Collaborator
There was a problem hiding this comment.
Thank you for this good improvements, I've made a few suggestions
Contributor
Author
|
@IzioDev Thanks for the review, updated the PR with your suggestions |
Collaborator
|
Awesome, thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README was still the default Create Fumadocs boilerplate and there was no contributor guidance, which makes it harder for newcomers to find their way around. This PR:
content/docs/, sidebar entries go inmeta.json), the checks CI runs, and a few writing guidelinescontent/docs/test.mdx, a leftover Fumadocs demo pageAll four CI checks (lint, format, types, build) pass locally.