Skip to content

Chore: Add footer component to add the license in all the pages#458

Open
scode2277 wants to merge 1 commit intodevelopfrom
chore/license-footer
Open

Chore: Add footer component to add the license in all the pages#458
scode2277 wants to merge 1 commit intodevelopfrom
chore/license-footer

Conversation

@scode2277
Copy link
Copy Markdown
Collaborator

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:

  • Describe your changes, substitute this text with the information
  • If you are touching an existing piece of content, tag current contributors from the attribution list
  • If there is a steward for that framework, ask the steward to review it
  • If you're modifying the general outline, make sure to update it in the vocs.config.ts adding the dev: true parameter
  • If you need feedback for your content from the wider community, share the PR in our Discord
  • Review changes to ensure there are no typos; see instructions below.

@scode2277 scode2277 added the enhancement Updates that improve or refine existing features, user experience, or system performance. label Apr 15, 2026
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying frameworks with  Cloudflare Pages  Cloudflare Pages

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

View logs

Copy link
Copy Markdown
Collaborator

@frameworks-volunteer frameworks-volunteer left a comment

Choose a reason for hiding this comment

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Updates that improve or refine existing features, user experience, or system performance.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants