Skip to content

docs: align entrypoint guidance, onboarding links, and module catalog references #231

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.

Sign up for GitHub

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

Open
michaeljabbour wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: align entrypoint guidance, onboarding links, and module catalog references #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ amplifier-log-viewer
Amplifier works with multiple AI providers:

- **Anthropic Claude** - Recommended, most tested (Sonnet 4.5, Opus 4.6, Haiku 4.5)
- **OpenAI** - Good alternative (GPT-5.2, GPT-5.2-Pro, GPT-5.1-Codex)
- **OpenAI** - Good alternative (GPT-5.4, GPT-5.4-Pro, GPT-5.4-Codex)
- **Azure OpenAI** - Enterprise users with Azure subscriptions (supports managed identity)
- **Ollama** - Local, free, no API key needed (llama3, codellama, etc.)

Expand Down Expand Up @@ -255,13 +255,12 @@ amplifier run --bundle recipes "Your prompt"
amplifier bundle use foundation
```

**The `foundation` bundle** is the default and includes:
**The `foundation` bundle** is the default bare-minimum configuration:

- **Tools**: filesystem, bash, web, search, task delegation
- **Agents**: 14 specialized agents (zen-architect, bug-hunter, git-ops, web-research, explorer, etc.)
- **Behaviors**: logging, redaction, streaming UI, todo tracking
- **Tools**: filesystem, bash
- **Agents**: None (agents ship in other bundles such as `dev`)

Most users never need to change bundles—foundation provides everything for development work.
Add bundles like `dev`, `recipes`, or `design-intelligence` for richer tooling and specialized agents.

### Working with Agents

Expand Down
32 changes: 1 addition & 31 deletions docs/REPOSITORY_RULES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,37 +185,7 @@ Modules are loaded using amplifier-foundation's internal APIs directly.

### Modules (Kernel Extensions)

**Context Managers**:
- amplifier-module-context-persistent
- amplifier-module-context-simple

**Hooks**:
- amplifier-module-hooks-approval
- amplifier-module-hooks-backup
- amplifier-module-hooks-logging
- amplifier-module-hooks-redaction
- amplifier-module-hooks-scheduler-cost-aware
- amplifier-module-hooks-scheduler-heuristic
- amplifier-module-hooks-streaming-ui

**Orchestrators**:
- amplifier-module-loop-basic
- amplifier-module-loop-events
- amplifier-module-loop-streaming

**Providers**:
- amplifier-module-provider-anthropic
- amplifier-module-provider-azure-openai
- amplifier-module-provider-mock
- amplifier-module-provider-ollama
- amplifier-module-provider-openai

**Tools**:
- amplifier-module-tool-bash
- amplifier-module-tool-filesystem
- amplifier-module-tool-search
- amplifier-module-tool-task
- amplifier-module-tool-web
For the current list of all runtime modules (orchestrators, providers, tools, context managers, hooks), see **[Module Catalog](MODULES.md)**.

**All Modules**:
- **Referenced By**: Apps/libraries via mount plans
Expand Down
10 changes: 5 additions & 5 deletions docs/USER_ONBOARDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Which bundle? [1] foundation [2] dev [3] full: 1
Ready! Try: amplifier run "Hello world"
```

**Note:** Azure OpenAI has additional setup (endpoint, deployment name, auth method). See examples in [amplifier/README.md](../amplifier/README.md#quick-start).
**Note:** Azure OpenAI has additional setup (endpoint, deployment name, auth method). See examples in [README.md](../README.md#quick-start).

**That's it!** You're configured and ready to use Amplifier.

Expand Down Expand Up @@ -634,10 +634,10 @@ When no scope specified, commands prompt interactively.
### Essential Reading

- **[Bundle Guide](https://github.com/microsoft/amplifier-foundation/blob/main/docs/BUNDLE_GUIDE.md)** - Creating and using bundles
- [SCENARIO_TOOLS_GUIDE.md](SCENARIO_TOOLS_GUIDE.md) - Building sophisticated CLI tools
- [Module Catalog](MODULES.md) - Available components and module development
- **[Agent Authoring](https://github.com/microsoft/amplifier-foundation/blob/main/docs/AGENT_AUTHORING.md)** - Create custom agents
- [TOOLKIT_GUIDE.md](TOOLKIT_GUIDE.md) - Toolkit utilities for building tools
- [context/KERNEL_PHILOSOPHY.md](context/KERNEL_PHILOSOPHY.md) - Core design principles
- [Developer Guide](DEVELOPER.md) - Building modules and extending Amplifier
- [Kernel Philosophy](https://github.com/microsoft/amplifier-core/blob/main/docs/KERNEL_PHILOSOPHY.md) - Core design principles

---

Expand All @@ -655,4 +655,4 @@ amplifier run "Explain the kernel design in @docs/AMPLIFIER_AS_LINUX_KERNEL.md"

The file content loads automatically while your @mention stays as a reference marker.

**Learn more**: See [MENTION_PROCESSING.md](MENTION_PROCESSING.md) for complete guide.
**Learn more**: See [User Guide](USER_GUIDE.md) for the complete reference.