feat(docs): add documentation site at apps/docs#54
Conversation
- 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
Summary of ChangesHello @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 Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
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.
| { | ||
| "binding": "DB", | ||
| "database_name": "code-please-docs-db", | ||
| "database_id": "" |
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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
Summary
apps/docsusing the docs-please Nuxt layerChanges
Structure
apps/docs/with Nuxt 4 configurationref/docs-pleaseas git submodule for docs-please layerpackage.jsonworkspaces to includeapps/*andref/docs-please/packages/*Documentation Content
Deployment
wrangler.jsoncTest Plan
bun install- Dependencies install successfullybun run build- Build completes without errorsbun run lint- No linting errorsbun run devin apps/docs)Closes #53