Skip to content

Conversation

@boneskull
Copy link
Owner

  • docs: move docs/plans to .plans
  • chore(theme): tweak type
  • docs(README): tweak headers for typedoc
  • docs: add typedoc site
  • chore(ci): add docs workflow

Copilot AI review requested due to automatic review settings January 6, 2026 07:41
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR configures TypeDoc for automated API documentation generation with a custom BARGS-themed design. The implementation includes GitHub Pages deployment, custom CSS theming based on the project's logo color palette, and a TypeDoc plugin for media asset management.

Key Changes:

  • Adds TypeDoc configuration with custom theming and two community plugins
  • Implements GitHub Actions workflow for automated documentation deployment to GitHub Pages
  • Creates custom CSS theme extracting colors from the BARGS logo (lime green, red, cyan, etc.)
  • Updates configuration files to support the documentation build process

Reviewed changes

Copilot reviewed 12 out of 30 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
.config/typedoc.js TypeDoc configuration with custom theme, syntax highlighting, and navigation links
.config/typedoc-plugin-bargs.js Custom TypeDoc plugin to copy media assets and inject icon links
site/media/bargs-theme.css Comprehensive custom CSS theme with light/dark mode support based on logo palette
site/media/*.{svg,png,ico} Favicon, web manifest, and brand icons for documentation site
site/media/footer.html Custom footer HTML with favicon links and copyright notice
.github/workflows/docs.yml CI/CD workflow for building and deploying docs to GitHub Pages
package.json Adds typedoc-plugin-extras and typedoc-plugin-mdn-links dependencies
tsconfig.json Excludes .config/*.js from TypeScript compilation
eslint.config.js Adds ESLint configuration for .config/*.js files
src/theme.ts Removes explicit type annotation for better type inference
README.md Adjusts header formatting for better TypeDoc parsing
.plans/*.md Moves planning documents from docs/plans to .plans directory
.gitignore Ignores generated docs/ directory

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@boneskull boneskull merged commit e90f7dd into main Jan 6, 2026
9 checks passed
@boneskull boneskull deleted the typedoc branch January 6, 2026 07:45
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