Skip to content

docs: improve README navigation and skill catalog discoverability#98

Merged
rosspeili merged 1 commit into
ARPAHLS:mainfrom
rosspeili:docs/issue-72-readme-navigation
May 23, 2026
Merged

docs: improve README navigation and skill catalog discoverability#98
rosspeili merged 1 commit into
ARPAHLS:mainfrom
rosspeili:docs/issue-72-readme-navigation

Conversation

@rosspeili
Copy link
Copy Markdown
Contributor

Improves README discoverability and documentation navigation without duplicating usage-guide content. Adds an early Skill library link under Mission, syncs the architecture tree with the current repo layout, compacts the Documentation section into a scannable table, and adds provider links after the Gemini example. Cross-links the skill catalog back to the project README. Keeps core install provider-agnostic (pip install -e .); scopes the [gemini] extra to the Gemini example section only.

Fixes #72

Description

README-only documentation update for #72:

  • Mission — compact Skill library link with category names
  • Architecture — minimal tree sync (card.json, docs/usage/, provider scripts in examples/)
  • Quick Start — core install stays pip install -e .; Gemini extra noted only under §4 Usage Example
  • Documentation — compact table with inline provider links instead of a long bullet list
  • docs/skills/README.md — link back to project README; brief skillware list hint

No skill logic, framework code, or dependency changes.

Type of Change (Matches Issue Templates)

  • Skill Proposal: New Skill (Contains manifest.yaml, skill.py, and instructions.md)
  • Bug Report Fix: Non-breaking change which fixes an execution error or framework bug
  • Doc Fix: Documentation Update
  • Framework Feature / RFC Updates: Core Framework Update (Changes to base_skill.py, loader.py, etc.)

Checklist (all PRs)

  • My code follows the Agent Code of Conduct.
  • I have run python -m flake8 . and pytest tests/ locally (or the subset relevant to this change).

New or updated skill

Skipped — documentation-only PR.

Constitution & Safety

Not applicable — no skill or runtime changes.

Related Issues

Fixes #72

Add skill library link under Mission, sync architecture tree, compact documentation table, provider links after Gemini example, and cross-link from skill catalog to README. Keep core install provider-agnostic; scope Gemini extra to the Gemini example section.

Fixes ARPAHLS#72
@rosspeili rosspeili merged commit a4f47aa into ARPAHLS:main May 23, 2026
5 checks passed
@rosspeili rosspeili deleted the docs/issue-72-readme-navigation branch May 23, 2026 17:35
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.

[Docs]: README discoverability and documentation navigation

1 participant