Chore: Add footer component to add the license in all the pages#458
Chore: Add footer component to add the license in all the pages#458mattaereal merged 1 commit intodevelopfrom
Conversation
Deploying frameworks with
|
| Latest commit: |
7d37b0b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://870d3a9e.frameworks-573.pages.dev |
| Branch Preview URL: | https://chore-license-footer.frameworks-573.pages.dev |
frameworks-volunteer
left a comment
There was a problem hiding this comment.
Model: `z-ai/glm-5.1` Reasoning: `high` Provider: `openrouter`
Reviewing the two new files: docs/footer.tsx and docs/styles.css additions.
Security: No issues. The link uses rel="noopener noreferrer" correctly. No secrets, no injection vectors, no unsafe patterns. Clean.
QA findings (2 issues, 1 suggestion):
ISSUE 1 -- Footer is not wired up and will not render.
The Footer component is created in docs/footer.tsx but is never imported or referenced in vocs.config.tsx or any layout file. Vocs does not auto-discover components from docs/. As-is, this PR adds dead code -- the footer will not appear on any page.
Two options to fix:
(a) Use vocs built-in outlineFooter config (renders in the sidebar outline area):
In vocs.config.tsx, add: outlineFooter:
Then import Footer from "./docs/footer"
(b) Use a custom layout override if you need the footer at the bottom of the content area (requires a docs/_layout.tsx or similar approach per vocs docs).
ISSUE 2 -- Missing trailing newline in docs/styles.css.
The appended .footer block ends without a newline character. This triggers git/editor warnings and is inconsistent with the rest of the file (which ends with a newline). Add a blank line after the closing brace.
SUGGESTION -- Copyright year may be outdated.
The footer says "© 2023". Consider using "© 2023-present" or "© 2023-2026" to keep it current without annual updates. Match whatever convention the LICENSE file uses.
|
@frameworks-volunteer acknowledge that the structure followed to implement the footer component is this -> https://vocs.dev/docs/structure#footer-component . The component is visible and completely functioning without the need of being implemented (as automatically tracked by vocs)! @mattaereal you can check it at the end of every page in the preview link -> https://chore-license-footer.frameworks-573.pages.dev/ |
frameworks-volunteer
left a comment
There was a problem hiding this comment.
Model: z-ai/glm-5.1 Reasoning: high Provider: openrouter
Re-reviewing after scode2277's clarification.
ISSUE 1 RETRACTED -- Footer IS auto-discovered by Vocs.
My original review was wrong on this point. Vocs uses virtual:consumer-components to auto-import docs/footer.tsx and renders it via DocsLayout -> Footer component. The footer file at docs/footer.tsx is correctly picked up without any import in vocs.config.tsx. The preview deployment confirms it renders. Apologies for the false flag.
Remaining findings (both minor):
-
Missing trailing newline in docs/styles.css -- the .footer block ends without a newline. Triggers git/editor warnings. Quick fix: add a blank line after the closing brace.
-
Copyright year -- "© 2023" may become outdated. Consider "© 2023-present" or match the LICENSE file convention to avoid annual updates.
Neither is blocking. Updating review to approved.
frameworks-volunteer
left a comment
There was a problem hiding this comment.
Model: z-ai/glm-5.1 Reasoning: high Provider: openrouter
Original blocking issue (footer not wired up) was incorrect -- Vocs auto-discovers docs/footer.tsx via virtual:consumer-components. Footer renders correctly in the preview deployment.
Two minor non-blocking suggestions remain:
- Add trailing newline to docs/styles.css
- Consider "© 2023-present" for the copyright year
Approved.
|
@frameworks-volunteer the year of the license is correct. this is how our license is written! |
Add vocs footer component in the docs folder so the license is visible in all the pages on the site
Frameworks PR Checklist
Thank you for contributing to the Security Frameworks! Before you open a PR, make sure to read information for contributors and take a look at the following checklist:
vocs.config.tsadding thedev: trueparameter