docs: improve taxonomy method visibility and quick references

[MicBun]

resolves: https://github.com/trufnetwork/truf-network/issues/1126

Summary by CodeRabbit

• Documentation
  • Expanded API reference for composed streams to cover taxonomy management, including clearer purpose, parameter/return details, and an example for DescribeTaxonomies.
  • Added a Quick Reference section mapping common tasks (deploying streams, inserting/retrieving data, managing taxonomy, destroying streams) to their corresponding methods for faster lookup.
  • Included a code example demonstrating how to fetch and iterate composed stream taxonomies, with error handling.
  • Added an API Reference entry to the Further Reading section.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation updated to include composed stream taxonomy management, examples, and quick reference entries. API reference expanded for DescribeTaxonomies with parameters, returns, and usage. An interface method DescribeTaxonomies was added to ComposedActions.

Changes

Cohort / File(s)	Summary
Docs: README enhancements README.md	Added taxonomy example for composed streams using DescribeTaxonomies; added Quick Reference mapping common SDK actions (duplicated entries); added API Reference link in Further Reading.
Docs: API Reference updates docs/api-reference.md	Expanded composed streams section for taxonomy management; detailed DescribeTaxonomies purpose, params (Stream, LatestVersion), returns (TaxonomyItem), and example usage; minor formatting adjustments.
API surface: Interface addition core/actions/composed_actions.go	Added ComposedActions method: DescribeTaxonomies(ctx context.Context, params types.DescribeTaxonomiesParams) ([]types.TaxonomyItem, error).

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Developer
  participant SDK as SDK (ComposedActions)
  participant Svc as TN Service

  Dev->>SDK: DescribeTaxonomies(ctx, {Stream, LatestVersion})
  SDK->>Svc: GET taxonomy for composed stream
  Svc-->>SDK: []TaxonomyItem{ChildStream, Weight} or error
  SDK-->>Dev: Return taxonomy list or error

  note over SDK,Svc: New/Documented interaction for taxonomy discovery

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Expose/get taxonomy in SDK documentation (#1126)	✅

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Added DescribeTaxonomies method to ComposedActions interface (core/actions/composed_actions.go)	Issue #1126 targets documentation visibility; altering the interface is not specified and may exceed the scope of fixing docs.

Suggested reviewers

• outerlook

Poem

I nibbled docs with careful bite,
Taxonomies now in clearer light.
Streams composed, their children told—
Weights and IDs neatly unrolled.
With twitching nose I pause to see,
A hoppy ref to API! 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between fe4ee13 and c396ecd.

📒 Files selected for processing (2)

• README.md (2 hunks)
• docs/api-reference.md (2 hunks)

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docsBetterVisi

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[MicBun]

I will merge immediately, so it can be used to customer.

[holdex]

Time Submission Status

Member	Status	Time	Action	Last Update
MicBun	✅ Submitted	1h 30min	Update time	Aug 21, 2025, 4:19 AM