[Docs] Some improvements to the Documentation #373
Conversation
WalkthroughThis update revises several documentation files. It clarifies extension requirements in multiple tutorials, updates a search argument for cinematic entries, adjusts a difficulty label, and amends the list of supported placeholders in the PlaceholderAPI documentation to include a new tracked objectives locations placeholder. Changes
Sequence Diagram(s)Not applicable; changes are limited to documentation and metadata updates. Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Suggested reviewers
Poem
Note 🔌 MCP (Model Context Protocol) integration is now available in Early Access!Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
documentation/docs/docs/05-helpful-features/03-placeholderapi.mdx (1)
68-68: Fix spelling error (“locatabe” → “locatable”).Minor typo in the new description.
- - `%tracked_objectives_locations%`: Returns the locations of the tracked locatabe objectives. (Format can be changed in the [snippets](./05-snippets.mdx)) + - `%tracked_objectives_locations%`: Returns the locations of the tracked locatable objectives. (Format can be changed in the [snippets](./05-snippets.mdx))documentation/docs/docs/03-creating-stories/04-entity-extension/index.mdx (1)
10-12: Use a less-severe admonition type for prerequisites
:::dangerrenders with a red “error” style that we usually reserve for destructive or critical warnings. A prerequisite notice is informative rather than hazardous, sowarningkeeps the visual hierarchy consistent with the rest of the docs.-:::danger[Required Extensions] +:::warning[Required Extensions]documentation/docs/docs/03-creating-stories/05-questing/index.mdx (1)
14-16: Alphabetise the extension list for consistencyAcross the docs we usually list the prerequisites alphabetically (
Entity, Quest, RoadNetwork). Keeping the same order avoids tiny diffs and helps readers scan quickly.-You must have installed the Quest, Entity and RoadNetwork Extensions before starting this tutorial. +You must have installed the Entity, Quest and RoadNetwork Extensions before starting this tutorial.documentation/docs/docs/03-creating-stories/06-road-network/index.mdx (1)
14-16: Maintain consistent ordering of prerequisite extensionsFor uniformity with other pages, list the extensions alphabetically:
-You must have installed the RoadNetwork, Entity and Quest Extensions before starting this tutorial. +You must have installed the Entity, Quest and RoadNetwork Extensions before starting this tutorial.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
documentation/docs/docs/03-creating-stories/02-cinematics/index.mdx(1 hunks)documentation/docs/docs/03-creating-stories/04-entity-extension/index.mdx(1 hunks)documentation/docs/docs/03-creating-stories/05-questing/index.mdx(1 hunks)documentation/docs/docs/03-creating-stories/06-road-network/index.mdx(1 hunks)documentation/docs/docs/03-creating-stories/07-advanced-interactions/02-custom-commands.mdx(1 hunks)documentation/docs/docs/05-helpful-features/03-placeholderapi.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: in the typewriter project's documentation mdx files, minimal front matter that includes only the `di...
Learnt from: Marten-Mrfc
PR: gabber235/Typewriter#333
File: documentation/docs/docs/03-creating-stories/04-entity-extension/04-activities.mdx:1-3
Timestamp: 2025-05-11T07:03:22.666Z
Learning: In the Typewriter project's documentation MDX files, minimal front matter that includes only the `difficulty` field is acceptable. Additional fields like `title`, `id`, or `sidebar_label` are not required even if the heading is present in the document body.
Applied to files:
documentation/docs/docs/05-helpful-features/03-placeholderapi.mdxdocumentation/docs/docs/03-creating-stories/07-advanced-interactions/02-custom-commands.mdx
🪛 LanguageTool
documentation/docs/docs/05-helpful-features/03-placeholderapi.mdx
[grammar] ~68-~68: Ensure spelling is correct
Context: ...`: Returns the locations of the tracked locatabe objectives. (Format can be changed in t...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (3)
documentation/docs/docs/05-helpful-features/03-placeholderapi.mdx (1)
64-70: Confirm placeholder prefix consistency.All existing placeholders use the
%typewriter_…%prefix except the newly added%tracked_objectives_locations%.
If the missing prefix is intentional (e.g., because the underlying PAPI registration differs), ignore this comment; otherwise, consider renaming for consistency.documentation/docs/docs/03-creating-stories/07-advanced-interactions/02-custom-commands.mdx (1)
2-2: Difficulty metadata update – looks goodThe bump from “Normal” to “Hard” is appropriate given the tutorial’s complexity. No further action needed.
documentation/docs/docs/03-creating-stories/02-cinematics/index.mdx (1)
27-27: ConfirmEntrySearchslug registrationIt looks like all live docs have been updated to use
<EntrySearch entryName='camera_cinematic'/>. The only remaining occurrences of'cinematic'are inversioned_docs/v*(historical snapshots), which should stay unchanged. Please verify:
- The editor actually registers an entry with the exact slug
camera_cinematic.- Any other code or config (e.g. editor manifests, example projects) referencing the old
cinematicslug have been updated accordingly.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
documentation/docs/docs/05-helpful-features/03-placeholderapi.mdx (1)
68-68: Fix typo in description of the new placeholder.
locatabe➔locatable.-%typewriter_tracked_objectives_locations%`: Returns the locations of the tracked locatabe objectives. (Format can be changed in the [snippets](./05-snippets.mdx)) +%typewriter_tracked_objectives_locations%`: Returns the locations of the tracked locatable objectives. (Format can be changed in the [snippets](./05-snippets.mdx))
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
documentation/docs/docs/05-helpful-features/03-placeholderapi.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-05-11T07:03:22.666Z
Learnt from: Marten-Mrfc
PR: gabber235/Typewriter#333
File: documentation/docs/docs/03-creating-stories/04-entity-extension/04-activities.mdx:1-3
Timestamp: 2025-05-11T07:03:22.666Z
Learning: In the Typewriter project's documentation MDX files, minimal front matter that includes only the `difficulty` field is acceptable. Additional fields like `title`, `id`, or `sidebar_label` are not required even if the heading is present in the document body.
Applied to files:
documentation/docs/docs/05-helpful-features/03-placeholderapi.mdx
🪛 LanguageTool
documentation/docs/docs/05-helpful-features/03-placeholderapi.mdx
[grammar] ~68-~68: Ensure spelling is correct
Context: ...`: Returns the locations of the tracked locatabe objectives. (Format can be changed in t...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Test Documentation Build
🔇 Additional comments (1)
documentation/docs/docs/05-helpful-features/03-placeholderapi.mdx (1)
64-64: Placeholder count statement aligns with list – looks good.The header now correctly reflects the addition of the fifth custom placeholder.
|
Very good spots and changes! Thanks again! |
2 participants
Heya! Here are a few minor changes and corrections to the documentation (nothing major, just small adjustments/improvements).
Summary by CodeRabbit