feat(book): add code kiko page use gitbook #2633
Conversation
go-wyvern
changed the title
Summary of ChangesHello @go-wyvern, 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 robust documentation system by integrating GitBook (HonKit) into the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a feature to display GitBook-generated tutorials within the application. The implementation includes a build script for the books, a new Vue component to render them in an iframe, and the tutorial content itself. My review has identified a couple of areas for improvement:
- The
build-books.shscript relies on a global npm installation, which is not a robust practice. I've suggested moving to a project-local dependency usingnpx. - The
books.vuecomponent has a bug in its loading logic and a user experience issue with the loading indicator. I've provided comments to fix the bug and address the UX problem.
The rest of the changes, including the updates to the tutorial markdown files for better navigation and syntax highlighting, are well-executed. Addressing the feedback will make the implementation more robust and user-friendly.
![xgopilot[bot]](https://avatars.githubusercontent.com/in/1924301?s=60&v=4){kind=small}
Code Review SummaryThis PR successfully adds GitBook documentation infrastructure with a clean Vue-based viewer. However, several critical issues need attention: Critical Issues:
High Priority:
Positive Notes:
Please address the security and critical issues before merging. |
There was a problem hiding this comment.
Pull request overview
This pull request adds GitBook (HonKit) integration to build and serve the CodeKiko tutorial documentation as an interactive web-based book. The implementation includes configuration files, a build script, and a Vue.js component to render the generated HTML within the application.
Key Changes:
- Converted code fences from
xgotogosyntax highlighting throughout all tutorial chapters - Added GitBook configuration files (book.json, .gitbook.yaml) and restructured summary.md for GitBook compatibility
- Implemented a books route handler with an iframe-based viewer component
- Created a build script to generate static HTML from markdown using HonKit
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| tutorial/codeKiko/book.json | GitBook configuration specifying title, language, and structure |
| tutorial/codeKiko/.gitbook.yaml | GitBook YAML config with structure definitions and placeholder redirects |
| tutorial/codeKiko/README.md | Updated chapter links to remove ./ prefix for GitBook compatibility |
| tutorial/codeKiko/summary.md | Restructured table of contents with GitBook-compatible anchor links |
| tutorial/codeKiko/chapter*.md | Changed all code fences from xgo to go for syntax highlighting |
| spx-gui/src/router.ts | Added wildcard route /books/:pathMatch(.*)* for book viewer |
| spx-gui/src/pages/books/books.vue | New Vue component rendering books in iframe with loading/error states |
| spx-gui/build-books.sh | Shell script to build GitBooks using HonKit |
| spx-gui/package.json | Updated npm scripts to include book building in postinstall and predev |
| spx-gui/.gitignore | Added public/books to ignore generated GitBook output |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ove unnecessary language tags and improve formatting consistency. Update examples and explanations for clarity and readability.
Replace arithmetic expansion ((count++)) with assignment form to avoid exit code 1 when incrementing from 0 under 'set -e'. The post-increment operator returns the pre-increment value (0), which causes bash to treat it as a failure exit code, triggering immediate script exit due to 'set -e'. Fixed locations: - built_count increment (line 51) - cached_count increment (line 54) - skipped_count increment (line 58) Generated with [codeagent](https://github.com/qbox/codeagent) Co-authored-by: go-wyvern <15845637+go-wyvern@users.noreply.github.com>
…-tutorial-books.sh
3 participants
No description provided.