Skip to content

[GIT-7] Publish design context - #8

Merged
pooriaarab merged 1 commit into
mainfrom
git-7-publish-design-context
Sep 1, 2026
Merged

pooriaarab merged 1 commit into
mainfrom
git-7-publish-design-context

Conversation

@pooriaarab

@pooriaarab pooriaarab commented Sep 1, 2026 •

Copy link
Copy Markdown
Owner

Closes #7

What

Add canonical brand and design documents.

Serve the canonical design bytes at /design.md.

Add the public /brand page and link it from the home page.

Why

GitMarkdown needs one grounded source for product copy and interface work.

The owned product domain also needs machine-readable and human-readable design context.

How I verified

npx eslint src/app/brand/page.tsx src/app/design.md/route.ts src/app/sitemap.ts -> Completed without errors.

Local /design.md request -> Returned 200 with text/markdown and byte-exact canonical content.

Local /brand request -> Returned 200 with the expected page content.

npm run build -> Compiled and type-checked. Page collection then stopped on missing Firebase credentials for the existing /api/github/pulls route.

git diff --check -> Completed without errors.

Proof: n/a — the production page requires this PR to deploy.

Assisted-by: Gemini:gemini-3.5-flash

Summary by CodeRabbit

  • New Features

    • Added a dedicated Brand page covering GitMarkdown’s identity, messaging, visual palette, typography, and interface principles.
    • Added a Brand link to the landing-page footer.
    • Included the Brand page in the site sitemap.
    • Added a route for accessing the product’s design guidelines as Markdown.
  • Documentation

    • Added brand and design guidelines for consistent product copy and visual experiences.

Document the implemented brand and interface system.

Expose the canonical design source and a public brand page on the owned
product domain.
@coderabbitai

coderabbitai Bot commented Sep 1, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: bcf4b508-fa88-4085-93d7-5d134b2c4247

📥 Commits

Reviewing files that changed from the base of the PR and between 73f2aed and cfa662b.

📒 Files selected for processing (7)
  • .agents/brand.md
  • .agents/design.md
  • AGENTS.md
  • src/app/brand/page.tsx
  • src/app/design.md/route.ts
  • src/app/page.tsx
  • src/app/sitemap.ts

Included review availability: 0 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.


📝 Walkthrough

Walkthrough

Adds brand and design guidance, a public /brand page, a static /design.md route, navigation links, and sitemap coverage.

Changes

Brand and design reference

Layer / File(s) Summary
Brand and design guidance
.agents/brand.md, .agents/design.md, AGENTS.md
Adds GitMarkdown brand rules, design-system guidance, and contributor instructions for using both documents.
Brand page and navigation
src/app/brand/page.tsx, src/app/page.tsx, src/app/sitemap.ts
Adds the /brand reference page with branding content, links it from the landing-page footer, and includes it in the sitemap.
Design document route
src/app/design.md/route.ts
Adds a statically forced GET route that returns .agents/design.md as UTF-8 Markdown.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to cfa66

This PR adds canonical design documentation and public brand content with localized route, sitemap, and home-page updates; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 4 files. (3 skipped: 3… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly identifies the main change: publishing the repository's design context. It is concise and specific.
Description check ✅ Passed The description includes the required issue reference, What, Why, verification steps, and assisted-by attribution. It also clearly reports the partial build limitation caused by missing Firebase crede…
Full details: Docstring Coverage

Explanation

Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 4 files. (3 skipped: 3 unsupported.)

Full details: Description check

Explanation

The description includes the required issue reference, What, Why, verification steps, and assisted-by attribution. It also clearly reports the partial build limitation caused by missing Firebase credentials.

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch git-7-publish-design-context

Comment @coderabbitai help to get the list of available commands.

@pooriaarab
pooriaarab merged commit ef23738 into main Sep 1, 2026
4 of 5 checks passed
@pooriaarab
pooriaarab deleted the git-7-publish-design-context branch September 1, 2026 20:28
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.

Publish canonical design context

1 participant