-
Notifications
You must be signed in to change notification settings - Fork 6
DA-1354 refactor: tutorial titles #84
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @VirajAgarwal1, 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 focuses on enhancing the readability and consistency of tutorial documentation by refactoring various H1 titles. The changes aim to make the tutorial headings more concise, descriptive, and aligned with best practices for technical documentation, ultimately improving the user experience and information retrieval. 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
|
There was a problem hiding this comment.
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 refactors titles in several tutorial markdown files. The changes are mostly good, improving consistency and document structure. I've found one instance where an H1 title is kept, but a comment in the file's frontmatter suggests it should be removed. I've left a specific comment with a suggestion for that file. The other changes look good.
tutorial/markdown/nodejs/quickstart-mastra/mastra-couchbase-nextJS-tutorial.md
Show resolved
Hide resolved
ejscribner
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything else looks great!
|
|
||
| <!-- [abstract] --> | ||
| # Quickstart for Couchbase in C++ | ||
| # Quickstart in Couchbase with C++ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think # Quickstart **for** Couchbase **in** C++ is more grammatically correct here, since we work "in" a language and the tutorial is "for" couchbase. It looks like its incorrect in the frontmatter, so perhaps we should change that back instead.
…multiple markdown files
c52789b to
7818c78
Compare
Refactor the H1 titles in the tutorial