Skip to content

Feat/zard how to - #678

Merged
Luizgomess merged 9 commits into
masterfrom
feat/zard-how-to
Aug 5, 2026
Merged

Feat/zard how to#678
Luizgomess merged 9 commits into
masterfrom
feat/zard-how-to

Conversation

@Luizgomess

@Luizgomess Luizgomess commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

What was done? 📝

adding an full guide of how to contribute in zard

Screenshots or GIFs 📸

image

Type of change 🏗

  • New feature (non-breaking change that adds functionality)
  • Bug fix (non-breaking change that fixes an issue)
  • Refactor (non-breaking change that improves the code or technical debt)
  • Chore (none of the above, such as upgrading libraries)

Checklist 🧐

  • Tested on Chrome
  • Tested on Safari
  • Tested on Firefox
  • No errors in the console

Summary by CodeRabbit

  • New Features
    • Added a dedicated contribution documentation section with sidebar navigation.
    • Added guides for setup, architecture, project structure, components, blocks, documentation, testing, workflow, releases, and FAQs.
    • Added searchable, scroll-aware navigation, code examples, checklists, troubleshooting guidance, and contribution requirements throughout the guides.
    • Contribution pages are now available through pre-rendered routes for faster access.

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 047032d3-497f-4732-9a82-549111bea10d

📥 Commits

Reviewing files that changed from the base of the PR and between c76b0ec and 088e7e3.

⛔ Files ignored due to path filters (56)
  • CONTRIBUTING.md is excluded by none and included by none
  • apps/web/public/docs/contribute.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/docs/contribute/architecture.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/docs/contribute/blocks.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/docs/contribute/components.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/docs/contribute/documentation.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/docs/contribute/faq.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/docs/contribute/project-structure.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/docs/contribute/release.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/docs/contribute/setup.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/docs/contribute/testing.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/docs/contribute/workflow.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/documentation/contribute/architecture.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/documentation/contribute/blocks.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/documentation/contribute/components.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/documentation/contribute/documentation.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/documentation/contribute/faq.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/documentation/contribute/overview.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/documentation/contribute/project-structure.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/documentation/contribute/release.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/documentation/contribute/setup.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/documentation/contribute/testing.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/documentation/contribute/workflow.md is excluded by !apps/web/public/** and included by apps/**
  • apps/web/public/llms.txt is excluded by !apps/web/public/** and included by apps/**
  • apps/web/src/generated/documentation/contribute/architecture.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/documentation/contribute/blocks.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/documentation/contribute/components.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/documentation/contribute/documentation.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/documentation/contribute/faq.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/documentation/contribute/overview.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/documentation/contribute/project-structure.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/documentation/contribute/release.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/documentation/contribute/setup.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/documentation/contribute/testing.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/documentation/contribute/workflow.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/pages/contribute/architecture.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/pages/contribute/blocks.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/pages/contribute/components.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/pages/contribute/documentation.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/pages/contribute/faq.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/pages/contribute/overview.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/pages/contribute/project-structure.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/pages/contribute/release.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/pages/contribute/setup.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/pages/contribute/testing.ts is excluded by !**/generated/** and included by apps/**
  • apps/web/src/generated/pages/contribute/workflow.ts is excluded by !**/generated/** and included by apps/**
  • tools/generators/block/files/__name__/block.ts.template is excluded by none and included by none
  • tools/generators/block/index.ts is excluded by none and included by none
  • tools/generators/block/schema.d.ts is excluded by none and included by none
  • tools/generators/block/schema.json is excluded by none and included by none
  • tools/generators/component/files/__name__/demo/__name__.ts.template is excluded by none and included by none
  • tools/generators/component/files/__name__/doc/api.md.template is excluded by none and included by none
  • tools/generators/component/files/__name__/doc/api.ts.template is excluded by none and included by none
  • tools/generators/component/index.ts is excluded by none and included by none
  • tools/generators/component/public-files/__name__/demo/default.md.template is excluded by none and included by none
  • tools/generators/component/public-files/__name__/doc/api.md.template is excluded by none and included by none
📒 Files selected for processing (27)
  • apps/web/prerender-routes.txt
  • apps/web/src/app/app.routes.ts
  • apps/web/src/app/domain/components/ai-assist/ai-assist.component.ts
  • apps/web/src/app/domain/pages/contribute/architecture/architecture.page.html
  • apps/web/src/app/domain/pages/contribute/architecture/architecture.page.ts
  • apps/web/src/app/domain/pages/contribute/blocks/blocks.page.html
  • apps/web/src/app/domain/pages/contribute/blocks/blocks.page.ts
  • apps/web/src/app/domain/pages/contribute/components/components.page.html
  • apps/web/src/app/domain/pages/contribute/components/components.page.ts
  • apps/web/src/app/domain/pages/contribute/contribute.routes.ts
  • apps/web/src/app/domain/pages/contribute/documentation/documentation.page.html
  • apps/web/src/app/domain/pages/contribute/documentation/documentation.page.ts
  • apps/web/src/app/domain/pages/contribute/faq/faq.page.html
  • apps/web/src/app/domain/pages/contribute/faq/faq.page.ts
  • apps/web/src/app/domain/pages/contribute/overview/overview.page.html
  • apps/web/src/app/domain/pages/contribute/overview/overview.page.ts
  • apps/web/src/app/domain/pages/contribute/project-structure/project-structure.page.html
  • apps/web/src/app/domain/pages/contribute/project-structure/project-structure.page.ts
  • apps/web/src/app/domain/pages/contribute/release/release.page.html
  • apps/web/src/app/domain/pages/contribute/release/release.page.ts
  • apps/web/src/app/domain/pages/contribute/setup/setup.page.html
  • apps/web/src/app/domain/pages/contribute/setup/setup.page.ts
  • apps/web/src/app/domain/pages/contribute/testing/testing.page.html
  • apps/web/src/app/domain/pages/contribute/testing/testing.page.ts
  • apps/web/src/app/domain/pages/contribute/workflow/workflow.page.html
  • apps/web/src/app/domain/pages/contribute/workflow/workflow.page.ts
  • apps/web/src/app/shared/constants/routes.constant.ts

📝 Walkthrough

Walkthrough

Added a contribution documentation section with ten lazy-loaded Angular pages. The section includes sidebar navigation, AI-assist route integration, SEO metadata, code examples, structured contributor guidance, and prerender entries.

Changes

Contribution documentation

Layer / File(s) Summary
Route and navigation integration
apps/web/src/app/app.routes.ts, apps/web/src/app/domain/pages/contribute/contribute.routes.ts, apps/web/src/app/shared/constants/routes.constant.ts, apps/web/prerender-routes.txt, apps/web/src/app/domain/components/ai-assist/ai-assist.component.ts
Added lazy-loaded contribution routes, sidebar links, AI-assist filtering, and prerender entries.
Contributor orientation and setup
apps/web/src/app/domain/pages/contribute/overview/*, apps/web/src/app/domain/pages/contribute/setup/*, apps/web/src/app/domain/pages/contribute/architecture/*, apps/web/src/app/domain/pages/contribute/project-structure/*
Added guidance for repository setup, workspace architecture, project structure, contribution types, commands, aliases, and generated artifacts.
Component, block, and documentation authoring
apps/web/src/app/domain/pages/contribute/components/*, apps/web/src/app/domain/pages/contribute/blocks/*, apps/web/src/app/domain/pages/contribute/documentation/*
Added workflows for contributing components and blocks, and for creating documentation pages with generators and Markdown processing.
Testing, workflow, release, and troubleshooting
apps/web/src/app/domain/pages/contribute/testing/*, apps/web/src/app/domain/pages/contribute/workflow/*, apps/web/src/app/domain/pages/contribute/release/*, apps/web/src/app/domain/pages/contribute/faq/*
Added testing, branch and commit, CI, release, and troubleshooting guidance with data-driven tables and code examples.

Estimated code review effort: 4 (Complex) | ~45 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Contributor
  participant Sidebar
  participant AppRoutes
  participant ContributePage
  Contributor->>Sidebar: Select contribution guide
  Sidebar->>AppRoutes: Navigate to /docs/contribute
  AppRoutes->>ContributePage: Lazy-load selected page
  ContributePage->>Contributor: Render navigation, guidance, and code blocks
Loading

Possibly related PRs

Suggested reviewers: srizzon

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title indicates a Zard UI feature but does not clearly identify the contribution documentation added. Rename the title to state the main change, such as "feat: add Zard UI contribution guide".
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The description explains the contribution guide, includes a screenshot, identifies the feature type, and records testing results.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/zard-how-to

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Comment thread tools/generators/block/index.ts Dismissed
Comment thread tools/generators/component/index.ts Dismissed
@Luizgomess
Luizgomess merged commit 171548b into master Aug 5, 2026
9 checks passed
@Luizgomess
Luizgomess deleted the feat/zard-how-to branch August 5, 2026 01:57
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.

2 participants