Chore: standardized frameworks and pages structure#487
Chore: standardized frameworks and pages structure#487
Conversation
frameworks-volunteer
left a comment
There was a problem hiding this comment.
Model: z-ai/glm-5.1 Reasoning: high Provider: openrouter
Review: Chore: standardized frameworks and pages structure
Security: PASS
No secrets, injection vectors, unsafe deserialization, dependency changes, or auth modifications. This is purely documentation (MDX + markdown).
QA Findings
1. Missing trailing newline (minor)
Both docs/pages/config/template.mdx and docs/pages/contribute/contributing.mdx are missing a final newline. Git diff shows \ No newline at end of file for both. Some tooling (cat, diffs, heredocs) behaves oddly without a trailing newline, and POSIX text files should end with one. Consider adding a blank line at the end of each file.
2. CONTRIBUTING.md mermaid example not wrapped in <MermaidRenderer> (minor)
The contributing.mdx correctly wraps its mermaid example in <MermaidRenderer> (the PR fixes the bare codeblock). However, CONTRIBUTING.md still uses a bare ```mermaid codeblock at line 366. While CONTRIBUTING.md is a GitHub-rendered file (not Vocs), the inconsistency means the two files that are supposed to mirror each other now diverge on this point. If the intent is to keep them in sync, the CONTRIBUTING.md mermaid example should also be updated to mention <MermaidRenderer>, or at minimum a comment should note that bare codeblocks work on GitHub but not in Vocs.
What looks good
- Template overhaul is a clear improvement: tiered required/optional structure, inline instructions in
[brackets], cleaner Key Takeaway guidance, removal of standalone "pitfalls" section in favor of anchored warnings. - "Add a new framework" section fills a real gap in the contributing guide.
dev: trueclarification (new pages keep the flag even in already-promoted categories) is an important clarification that was missing.- Stewardship promoted from a buried one-liner to a "Want to take on more?" subsection with proper linking to Spotlight Zone.
- Workflow reordered so attribution (frontmatter + contributors.json) happens before opening the PR -- makes sense.
- Import path resolution note for nested pages is a practical addition.
- Frontmatter section compressed to defer to the template as source of truth -- reduces drift.
Verdict
Two minor issues, nothing blocking. Approving.
Deploying frameworks with
|
| Latest commit: |
d220974
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://59fbd9ae.frameworks-573.pages.dev |
| Branch Preview URL: | https://chore-template-file.frameworks-573.pages.dev |
|
@frameworks-volunteer end of file newline fixed. Regarding the mermaid component: that components is necessary only in .mdx files, mermaid code blocks work just fine in .md files |
|
Model: Acknowledged on both points:
Review stands approved -- no remaining issues. |
This PR refreshes
docs/pages/config/template.mdxand the contributing guide to align with how the project actually works today and to give contributors a clearer, more structured starting point.Template updates
[brackets]next to each section, so contributors see the rules where they write rather than scrolling between guidance and content.Contributing guide updates
contributors.json) happens before opening the PR.dev: trueframing: it's set on all new content, not just during review. Reviewed content gets promoted to production periodically whendevelopmerges intomain. Added clarification that a new page should keepdev: trueeven when its parent category does not.<MermaidRenderer>so it actually renders.