Add public project guidance and repository quality checks - #21
Merged
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
This PR bootstraps Huabu’s public-facing project scaffolding: contributor/support guidance, repo-level quality gates (lint/format/typecheck/test/build + license header enforcement), and a deployable “User Handbook” web app (Vite + SSR prerender + Pagefind search) published to GitHub Pages.
Changes:
- Added repository automation (CI, docs deployment, source-header checks) plus issue templates and contribution/support docs.
- Introduced a pnpm workspace with ESLint/Prettier configuration and a license-header enforcement script.
- Added
apps/docsas a standalone handbook site with prerendering, validation, and search indexing.
Reviewed changes
Copilot reviewed 64 out of 137 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| SUPPORT.md | Replaces template text with Huabu support and reporting guidance. |
| SECURITY.md | Minor formatting/line-number normalization in the Microsoft security block. |
| scripts/check-headers.mjs | Adds a repo-wide license-header checker for tracked source files. |
| README.md | Replaces template README with Huabu product, install, support, and licensing guidance. |
| RAI_README.md | Adds Responsible AI transparency documentation for Huabu. |
| pnpm-workspace.yaml | Defines pnpm workspace packages under apps/* and packages/*. |
| package.json | Adds root scripts for lint/format/typecheck/test/build/header checks and devDependencies. |
| eslint.config.mjs | Introduces flat ESLint config for TS/React + import ordering + Node globals. |
| demo.js | Removes the demo Express file. |
| CONTRIBUTING.md | Adds contribution scope + CLA + CoC + license guidance. |
| assets/huabu-logo.svg | Adds Huabu logo asset used by the README. |
| apps/docs/vitest.config.ts | Adds Vitest config (Happy DOM) merged with Vite config. |
| apps/docs/vite.config.ts | Adds Vite config with base-path normalization and docs dev server ports. |
| apps/docs/tsconfig.node.json | Adds TS config for Node-side docs tooling (vite/vitest/scripts). |
| apps/docs/tsconfig.json | Adds strict TS config for the docs client app. |
| apps/docs/src/vite-env.d.ts | Adds Vite types and a module shim for Pagefind UI. |
| apps/docs/src/sections/space/DataAndBackup.tsx | Adds handbook page documenting on-disk data layout and editing guidance. |
| apps/docs/src/sections/reference/Shortcuts.tsx | Adds handbook page rendering shortcut tables with formatting helpers. |
| apps/docs/src/sections/reference/IssueReporting.tsx | Adds handbook page describing how to file issues safely and effectively. |
| apps/docs/src/sections/QuickStart.tsx | Adds task-based Quick Start handbook landing page. |
| apps/docs/src/sections/ai/WorkWithAI.tsx | Adds handbook page describing Chat/Agent/Agent Node workflows. |
| apps/docs/src/sections/ai/ModelsAndCapabilities.tsx | Adds handbook page describing model roles and optional capabilities. |
| apps/docs/src/sections/ai/MemoryAndSkills.tsx | Adds handbook page describing Memory vs Skills and their storage locations. |
| apps/docs/src/NotFound.tsx | Adds docs-site 404 page. |
| apps/docs/src/normalizeBasePath.ts | Adds helper for consistent /base/ formatting for deployments. |
| apps/docs/src/navigation.ts | Adds single source of truth for handbook routes + manifest metadata. |
| apps/docs/src/navigation.test.ts | Adds tests asserting route structure and published surface constraints. |
| apps/docs/src/main.tsx | Adds hydration entrypoint for the docs app. |
| apps/docs/src/index.css | Adds Tailwind + Pagefind UI imports and docs styling. |
| apps/docs/src/entry-server.tsx | Adds SSR entry for prerendering routes at build time. |
| apps/docs/src/DocsLayout.tsx | Adds overall docs layout and sidebar/navigation shell. |
| apps/docs/src/DocsApp.tsx | Adds routing and dynamic section loading with title management. |
| apps/docs/src/config/shortcuts.ts | Adds a public shortcut catalog for the handbook. |
| apps/docs/src/config/shortcuts.test.ts | Adds tests for shortcut catalog ordering and invariants. |
| apps/docs/src/config/nodeIcons.ts | Adds icon registry for node types used in docs pages. |
| apps/docs/src/components/Toc.tsx | Adds right-side table-of-contents component. |
| apps/docs/src/components/Table.tsx | Adds small data table component for reference pages. |
| apps/docs/src/components/Shortcut.tsx | Adds OS-aware shortcut chip rendering to avoid hydration mismatch. |
| apps/docs/src/components/Search.tsx | Adds Pagefind-powered search modal with keyboard shortcuts and focus trap. |
| apps/docs/src/components/PageLayout.tsx | Adds per-page chrome (title/description/content/optional TOC). |
| apps/docs/src/components/Link.tsx | Adds styled link component (internal routing vs anchors vs external). |
| apps/docs/src/components/index.ts | Adds barrel exports for docs component library. |
| apps/docs/src/components/Image.tsx | Adds image embed component with base-path handling and caption support. |
| apps/docs/src/components/Heading.tsx | Adds typography primitives with auto slug/id generation. |
| apps/docs/src/components/Code.tsx | Adds inline code, code blocks, and keyboard key styling primitives. |
| apps/docs/src/components/cn.ts | Adds local className combiner for docs module. |
| apps/docs/src/components/Card.tsx | Adds navigation card components for hub-style pages. |
| apps/docs/src/components/Callout.tsx | Adds callout strip component (info/tip/warning). |
| apps/docs/src/basePath.ts | Adds base-path helpers for router basename and URL resolution. |
| apps/docs/src/basePath.test.ts | Adds tests for base-path normalization and resolution. |
| apps/docs/scripts/validate-build.mjs | Adds post-build validation for prerendered output + local references + Pagefind. |
| apps/docs/scripts/prerender.mjs | Adds prerender step that emits route HTML + canonical tags + root redirect. |
| apps/docs/README.md | Adds docs package readme with build/test/check instructions. |
| apps/docs/public/favicon.svg | Adds docs-site favicon SVG. |
| apps/docs/postcss.config.js | Adds Tailwind PostCSS configuration for docs app. |
| apps/docs/package.json | Adds docs app package config (build/prerender/pagefind/validate, tests, deps). |
| apps/docs/index.html | Adds docs app HTML template. |
| apps/docs/.npmrc | Pins npm registry for the docs app workspace. |
| apps/docs/dist/.vite/manifest.json | Adds generated docs build artifact (Vite manifest). |
| apps/docs/dist/assets/Callout-CAk_qUGJ.js | Adds generated docs build asset. |
| apps/docs/dist/assets/DataAndBackup-DYbSIWwI.js | Adds generated docs build asset. |
| apps/docs/dist/assets/ExternalAgents-xqj7yEwt.js | Adds generated docs build asset. |
| apps/docs/dist/assets/Image-BLy4u_I0.js | Adds generated docs build asset. |
| apps/docs/dist/assets/IssueReporting-DJhRs40A.js | Adds generated docs build asset. |
| apps/docs/dist/assets/Link-DsJcnbn_.js | Adds generated docs build asset. |
| apps/docs/dist/assets/MemoryAndSkills-CROYRc2t.js | Adds generated docs build asset. |
| apps/docs/dist/assets/ModelsAndCapabilities-D9B5wxJA.js | Adds generated docs build asset. |
| apps/docs/dist/assets/PageLayout-CKpAdFum.js | Adds generated docs build asset. |
| apps/docs/dist/assets/QuickStart-Baqt3ebw.js | Adds generated docs build asset. |
| apps/docs/dist/assets/Shortcuts-CMVOAkh6.js | Adds generated docs build asset. |
| apps/docs/dist/assets/Table-VorxCt1B.js | Adds generated docs build asset. |
| apps/docs/dist/assets/WorkInASpace-NkL78zlT.js | Adds generated docs build asset. |
| apps/docs/dist/assets/WorkWithAI-BbSdzA3c.js | Adds generated docs build asset. |
| apps/docs/dist/assets/index-BSLSy_Rq.css | Adds generated docs build asset (CSS bundle). |
| apps/docs/dist/assets/index-Dh5JqlAt.js | Adds generated docs build asset (main JS bundle). |
| apps/docs/dist/assets/nodeIcons-DlAnuOZ-.js | Adds generated docs build asset. |
| apps/docs/dist/assets/pencil-Czm6hCpE.js | Adds generated docs build asset. |
| apps/docs/dist/assets/settings-sTxJNAUR.js | Adds generated docs build asset. |
| apps/docs/dist/assets/ui-core-P_hod1yq.js | Adds generated docs build asset (Pagefind UI core). |
| apps/docs/dist/docs/index.html | Adds generated prerendered docs page (overview). |
| apps/docs/dist/docs/quick-start/index.html | Adds generated prerendered docs page. |
| apps/docs/dist/docs/quick-start/add-content.png | Adds generated docs static image. |
| apps/docs/dist/docs/quick-start/configure-llm.png | Adds generated docs static image. |
| apps/docs/dist/docs/quick-start/create-canvas.png | Adds generated docs static image. |
| apps/docs/dist/docs/work-in-a-space/index.html | Adds generated prerendered docs page. |
| apps/docs/dist/docs/work-in-a-space/quick-create-arrows-full.png | Adds generated docs static image. |
| apps/docs/dist/docs/work-with-ai/index.html | Adds generated prerendered docs page. |
| apps/docs/dist/docs/space/data-and-backup/index.html | Adds generated prerendered docs page. |
| apps/docs/dist/docs/reference/issues/index.html | Adds generated prerendered docs page. |
| apps/docs/dist/docs/reference/shortcuts/index.html | Adds generated prerendered docs page. |
| apps/docs/dist/docs/ai/external-agents/index.html | Adds generated prerendered docs page. |
| apps/docs/dist/docs/ai/memory-and-skills/index.html | Adds generated prerendered docs page. |
| apps/docs/dist/docs/ai/models-and-capabilities/index.html | Adds generated prerendered docs page. |
| apps/docs/dist/favicon.png | Adds generated docs build artifact (favicon PNG). |
| apps/docs/dist/favicon.svg | Adds generated docs build artifact (favicon SVG). |
| apps/docs/dist/index.html | Adds generated root redirect page for the built handbook. |
| apps/docs/dist/pagefind/pagefind-entry.json | Adds generated Pagefind metadata. |
| apps/docs/dist/pagefind/pagefind-highlight.js | Adds generated Pagefind runtime asset. |
| apps/docs/dist/pagefind/pagefind-modular-ui.css | Adds generated Pagefind modular UI stylesheet. |
| apps/docs/dist/pagefind/pagefind-modular-ui.js | Adds generated Pagefind modular UI script. |
| apps/docs/dist/pagefind/pagefind-ui.css | Adds generated Pagefind UI stylesheet. |
| apps/docs/dist/pagefind/pagefind-ui.js | Adds generated Pagefind UI script. |
| apps/docs/dist/pagefind/pagefind-worker.js | Adds generated Pagefind worker. |
| apps/docs/dist/pagefind/pagefind.en_967ffd9329.pf_meta | Adds generated Pagefind index metadata. |
| apps/docs/dist/pagefind/pagefind.js | Adds generated Pagefind runtime. |
| apps/docs/dist/pagefind/pagefind-component-ui.css | Adds generated Pagefind component UI stylesheet. |
| apps/docs/dist/pagefind/pagefind-component-ui.js | Adds generated Pagefind component UI script. |
| apps/docs/dist/pagefind/wasm.en.pagefind | Adds generated Pagefind WASM asset. |
| apps/docs/dist/pagefind/wasm.unknown.pagefind | Adds generated Pagefind WASM asset. |
| apps/docs/dist/pagefind/en_a3bbc16.pf_index | Adds generated Pagefind index shard. |
| apps/docs/dist/pagefind/en_3b27c37.pf_fragment | Adds generated Pagefind fragment shard. |
| apps/docs/dist/pagefind/en_8515e78.pf_fragment | Adds generated Pagefind fragment shard. |
| apps/docs/dist/pagefind/en_9a5cf25.pf_fragment | Adds generated Pagefind fragment shard. |
| apps/docs/dist/pagefind/en_9c82a57.pf_fragment | Adds generated Pagefind fragment shard. |
| apps/docs/dist/pagefind/en_a4608c8.pf_fragment | Adds generated Pagefind fragment shard. |
| apps/docs/dist/pagefind/en_b623c51.pf_fragment | Adds generated Pagefind fragment shard. |
| apps/docs/dist/pagefind/en_e77d308.pf_fragment | Adds generated Pagefind fragment shard. |
| apps/docs/dist/pagefind/en_f0be528.pf_fragment | Adds generated Pagefind fragment shard. |
| apps/docs/dist/pagefind/en_f378543.pf_fragment | Adds generated Pagefind fragment shard. |
| .prettierrc.json | Adds repository Prettier formatting configuration (incl. Tailwind plugin). |
| .prettierignore | Ignores generated build outputs and common artifacts. |
| .gitignore | Ignores docs build outputs and tsbuildinfo artifacts. |
| .github/workflows/sync-release.yml | Adds/updates workflow to sync upstream release assets into this repo. |
| .github/workflows/deploy-docs.yml | Adds workflow to build/prerender/index and deploy docs to GitHub Pages. |
| .github/workflows/ci.yml | Adds CI workflow running the full repo quality gate. |
| .github/workflows/check-source-headers.yml | Adds workflow to run the source header checker. |
| .github/ISSUE_TEMPLATE/config.yml | Adds issue template config with handbook link and enables blank issues. |
| .github/ISSUE_TEMPLATE/bug_report.yml | Adds structured bug report issue form. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces initial repository configuration for Huabu, focusing on responsible open-source and research practices, issue reporting, and automation for CI/CD. The changes add essential documentation for contributors and responsible AI use, set up GitHub workflows for CI, documentation deployment, and release synchronization, and provide templates to standardize bug reports and community engagement.
The most important changes are:
Repository Documentation and Responsible AI
CONTRIBUTING.mdoutlining contribution scope, code of conduct, license, and reporting guidelines.RAI_README.mddescribing responsible AI principles, intended uses, limitations, best practices, and contact information for Huabu.GitHub Issue and Community Configuration
.github/ISSUE_TEMPLATE/bug_report.ymlto standardize bug reports, emphasizing reproducibility and privacy..github/ISSUE_TEMPLATE/config.ymlto enable blank issues and provide a handbook link for user support.Automation: CI/CD and Release Management
.github/workflows/ci.ymlfor automated linting, formatting, type-checking, testing, and building on PRs and pushes tomain..github/workflows/deploy-docs.ymlfor building and deploying the user handbook to GitHub Pages on changes to documentation or workflow files..github/workflows/sync-release.ymlfor synchronizing releases and assets from an upstream repository, supporting manual dispatch and tag selection.Code Formatting
.prettierrc.jsonand.prettierignoreto enforce consistent code style and formatting, including Tailwind CSS plugin support. [1] [2]This pull request introduces essential project infrastructure for Huabu, including workflows for CI and documentation deployment, issue templates, and contribution guidelines. It also adds configuration for code formatting and responsible AI documentation. These changes lay the foundation for effective project collaboration, automated quality checks, and responsible open-source practices.GitHub Workflows and Automation:
.github/workflows/ci.ymlto run linting, formatting, type checks, tests, builds, and source header checks on pull requests and pushes tomain, with concurrency management..github/workflows/deploy-docs.ymlto build and deploy the user handbook to GitHub Pages on pushes tomainaffecting documentation or on manual trigger.Issue Reporting and Contribution Guidance:
.github/ISSUE_TEMPLATE/bug_report.ymlto standardize bug reports, ensuring users provide clear reproduction steps, system info, and avoid sharing sensitive data..github/ISSUE_TEMPLATE/config.ymlwith a link to the Huabu Handbook and enabled blank issues.CONTRIBUTING.mdwith scope, CLA, code of conduct, and license information for contributors.Responsible AI, Code Formatting, and Documentation:
RAI_README.mddetailing responsible AI principles, intended use, limitations, and best practices for Huabu..prettierrc.jsonand.prettierignoreto enforce consistent code formatting across the project, including Tailwind CSS support. [1] [2]