Skip to content

feat(docs): add documentation site at apps/docs#54

Merged
amondnet merged 3 commits into
mainfrom
53-add-documentation-site-at-appsdocs-using-docs-please-layer
Dec 22, 2025
Merged

feat(docs): add documentation site at apps/docs#54
amondnet merged 3 commits into
mainfrom
53-add-documentation-site-at-appsdocs-using-docs-please-layer

Conversation

@amondnet

Copy link
Copy Markdown
Contributor

Summary

  • Add documentation site at apps/docs using the docs-please Nuxt layer
  • Integrate with Cloudflare Pages for deployment (D1 database support)
  • Document all four packages: @pleaseai/code, @pleaseai/code-format, @pleaseai/code-lsp, @pleaseai/dora

Changes

Structure

  • Created apps/docs/ with Nuxt 4 configuration
  • Added ref/docs-please as git submodule for docs-please layer
  • Updated root package.json workspaces to include apps/* and ref/docs-please/packages/*

Documentation Content

  • Getting Started: Introduction, Installation, Quick Start guides
  • Guides: Claude Code Hooks, Auto-Formatting, LSP Diagnostics, MCP Server
  • Configuration: Overview, Formatter Config, LSP Config
  • Reference: CLI Commands, Supported Languages, API

Deployment

  • Cloudflare Pages configuration with wrangler.jsonc
  • D1 database binding for @nuxt/content

Test Plan

  • bun install - Dependencies install successfully
  • bun run build - Build completes without errors
  • bun run lint - No linting errors
  • Manual verification of dev server (bun run dev in apps/docs)
  • Cloudflare Pages deployment after D1 database creation

Closes #53

- Add apps/docs Nuxt project using docs-please layer
- Add docs-please as git submodule at ref/docs-please
- Add workspace reference to docs-please layer
- Create comprehensive documentation content:
  - Getting Started (introduction, installation, quick-start)
  - Guides (claude-code-hooks, auto-formatting, lsp-diagnostics, mcp-server)
  - Configuration (overview, formatter-config, lsp-config)
  - Reference (cli-commands, supported-languages, api)
- Configure Cloudflare Pages deployment with D1 database

Closes #53
- Fix YAML formatting in code examples
- Use single quotes for scoped npm packages in YAML
@amondnet amondnet linked an issue Dec 21, 2025 that may be closed by this pull request
13 tasks
@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello @amondnet, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new, centralized documentation website for the code-please project. Leveraging Nuxt and the docs-please layer, it provides a unified and navigable resource for users to understand the project's CLI tool, Claude Code plugin, and its various packages. The site is set up for efficient deployment on Cloudflare Pages, complete with D1 database integration for content management.

Highlights

  • New Documentation Site: A dedicated documentation site has been added at apps/docs, built using the docs-please Nuxt layer.
  • Cloudflare Pages Integration: The site is configured for deployment on Cloudflare Pages, including support for D1 database.
  • Comprehensive Documentation: All four core packages (@pleaseai/code, @pleaseai/code-format, @pleaseai/code-lsp, @pleaseai/dora) are now thoroughly documented.
  • Monorepo Structure Update: The root package.json workspaces have been updated to include the new apps/* directory and the ref/docs-please/packages/* submodule.
  • Git Submodule Inclusion: The docs-please layer is integrated as a git submodule under ref/docs-please.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a comprehensive documentation site for the code-please project, located at apps/docs. The site is built with Nuxt and the docs-please layer, and it's configured for deployment on Cloudflare Pages with D1 database support. The documentation covers all packages, providing getting started guides, configuration details, and API references. The changes are well-structured and the documentation is thorough. I have a couple of suggestions to improve clarity and align the implementation with the provided specification.

Comment thread apps/docs/wrangler.jsonc Outdated
{
"binding": "DB",
"database_name": "code-please-docs-db",
"database_id": ""

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The database_id is currently empty. While this is expected for the initial setup, it can be a source of confusion for developers trying to deploy the site. To improve clarity, consider adding a comment explaining that this ID will be populated upon database creation in Cloudflare, as noted in the test plan.

      "database_id": "" // To be populated after D1 database creation


## Clarified Decisions

1. **Dependency**: docs-please from npm registry (simpler setup, versioned updates)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The implementation appears to contradict this clarified decision in the specification. The spec states that docs-please will be used from the npm registry for a simpler setup. However, the pull request adds it as a git submodule and uses a workspace dependency. While using a submodule is a valid approach, it differs from the documented decision and can introduce extra steps for contributors (e.g., initializing and updating submodules). If this change in approach was intentional, it would be beneficial to update the specification document to reflect the final implementation and the reasoning behind it.

- Fix CLI lsp-server command docs (remove non-existent subcommands)
- Remove rustfmt from docs (not implemented in formatter registry)
- Fix package counts (18+ formatters, 30 LSP servers)
- Fix format hook output description (silent on success)
- Fix API reference (LSPManager constructor, shutdown method)
- Add TODO comment for wrangler.jsonc database_id
@amondnet
amondnet merged commit ad05127 into main Dec 22, 2025
0 of 3 checks passed
@amondnet
amondnet deleted the 53-add-documentation-site-at-appsdocs-using-docs-please-layer branch December 22, 2025 02:53
@passionfactory-bot passionfactory-bot Bot mentioned this pull request Dec 21, 2025
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.

Add documentation site at apps/docs using docs-please layer

1 participant