Skip to content

Comments

chore: improve docs#36

Merged
yordis merged 3 commits intomainfrom
yordis/chore-1
Nov 24, 2025
Merged

chore: improve docs#36
yordis merged 3 commits intomainfrom
yordis/chore-1

Conversation

@yordis
Copy link
Member

@yordis yordis commented Nov 24, 2025

No description provided.

@cursor
Copy link

cursor bot commented Nov 24, 2025

PR Summary

Refresh docs to use claude/... marketplace naming and .cursor/{type}/aipm/ paths, clean up links/related sections, and add TrogonAI ignores to .gitignore.

  • Docs:
    • Update Claude marketplace identifiers to claude/... and adjust install examples in README.md and tutorials.
    • Change sync targets and verification paths to .cursor/{type}/aipm/ in getting-started and related guides.
    • Fix docs navigation: point installation links to docs/how-to/installation.md.
    • Prune/clean “Related” sections and outdated references across multiple docs (architecture.md, create-marketplace.md, debug-plugins.md, cli-commands.md, tutorials).
  • Repo:
    • .gitignore: add TrogonAI internal file patterns (.trogonai/, *.internal.trogonai.md).

Written by Cursor Bugbot for commit 7b782ae. This will update automatically on new commits. Configure here.

@coderabbitai
Copy link

coderabbitai bot commented Nov 24, 2025

Caution

Review failed

The head commit changed during the review from d751217 to 7b782ae.

Walkthrough

The PR updates documentation and configuration files to reflect a migration from marketplace-based directory structure (.cursor/marketplace/) to a type-based structure (.cursor/{type}/aipm/), and updates Claude marketplace identifiers from colon-based (claude:) to slash-based (claude/) naming. Several cross-reference and related sections are removed from documentation files.

Changes

Cohort / File(s) Summary
Configuration
.gitignore
Adds two TrogonAI internal file ignore rules: .trogonai/ directory and *.internal.trogonai.md pattern under new section comment.
Marketplace identifiers
README.md, docs/tutorials/getting-started.md
Updates Claude marketplace identifiers from colon-based to slash-based format (claude:claude/) and corresponding install commands for anthropic-agent-skills and claude-code-workflows.
Documentation link migration
docs/README.md
Updates two installation guide references from ../INSTALLATION.md to ./how-to/installation.md in Quick Start and For Users sections.
Documentation cleanup - related/reference sections
docs/explanation/architecture.md, docs/how-to/configure-aipm.md, docs/how-to/create-marketplace.md, docs/how-to/debug-plugins.md, docs/reference/cli-commands.md, docs/tutorials/first-plugin.md
Removes cross-references, "Related" subsections, and "See also" references across multiple documentation files.
Tutorial path structure migration
docs/tutorials/getting-started.md
Updates directory paths from marketplace-oriented (.cursor/marketplace/...) to type-based structure (.cursor/{type}/aipm/...), updates example commands to use new path conventions, and updates marketplace identifiers to slash-based format.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • Key focus areas:
    • Path migration in docs/tutorials/getting-started.md requires verification that all examples correctly reflect the new .cursor/{type}/aipm/ structure
    • Marketplace identifier changes (claude:claude/) consistency across README.md and tutorial files
    • Verify removed cross-references in documentation don't break intended user navigation patterns

Possibly related PRs

Poem

🐰 Hops through docs with glee,
Slashes replace colons, so clean and free,
Paths reorganized, type-based today,
No marketplace maze—just aipm's way!
Configuration blooms, links trimmed just right,

Pre-merge checks and finishing touches

❌ Failed checks (2 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'chore: improve docs' is vague and generic, using non-descriptive language that doesn't convey the specific nature of the documentation changes. Replace with a more specific title that describes the main changes, such as 'chore: update marketplace identifiers and reorganize documentation structure'.
Description check ❓ Inconclusive No pull request description was provided by the author, making it impossible to assess whether it relates to the changeset. Add a description that explains the main objectives of the changes, such as updating marketplace identifiers from colon to slash format and reorganizing documentation links.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@yordis yordis changed the title yordis/chore 1 chore: improve docs Nov 24, 2025
@yordis yordis marked this pull request as ready for review November 24, 2025 10:08
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
@yordis yordis merged commit 630b6ea into main Nov 24, 2025
1 of 2 checks passed
@yordis yordis deleted the yordis/chore-1 branch November 24, 2025 10:21
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.

1 participant