Skip to content

Commit f297041

Browse files
committed
feat: move experimental section under User Guide after Deploy
- Reorganize navigation to place Experimental as a subsection under User Guide - Position Experimental after Deploy section for logical flow - Update EXPERIMENTAL-DOC-PLAN.md to reflect new structure - Mark implementation phases as completed - Add implementation status note with completion date
1 parent b24729f commit f297041

File tree

2 files changed

+72
-49
lines changed

2 files changed

+72
-49
lines changed

EXPERIMENTAL-DOC-PLAN.md

Lines changed: 63 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
# Experimental Features Documentation Plan
22

3+
## Implementation Status
4+
5+
**COMPLETED** - This plan has been successfully implemented as of August 2025.
6+
7+
The experimental documentation has been migrated from the sdk-python repository and integrated into the strands-docs repository under the User Guide section. All configuration loader documentation is now available at:
8+
9+
- `docs/experimental/README.md` - Experimental features overview
10+
- `docs/experimental/config-loader/overview.md` - Configuration loaders overview
11+
- `docs/experimental/config-loader/agent-config.md` - Agent configuration guide
12+
- `docs/experimental/config-loader/tool-config.md` - Tool configuration guide
13+
- `docs/experimental/config-loader/swarm-config.md` - Swarm configuration guide
14+
- `docs/experimental/config-loader/graph-config.md` - Graph configuration guide
15+
- `docs/experimental/config-loader/structured-output.md` - Structured output guide
16+
17+
The navigation has been updated to include the experimental section under User Guide → Experimental.
18+
19+
---
20+
321
## Overview
422

523
This document outlines a comprehensive plan for adding an **Experimental** section to the Strands Agents documentation. The experimental section will document features that are in development, preview, or beta status, providing users with early access to cutting-edge functionality while clearly communicating the experimental nature of these features.
@@ -30,7 +48,10 @@ User Guide/
3048
│ └── Multi-agent/
3149
├── Safety & Security/
3250
├── Observability & Evaluation/
33-
└── Deploy/
51+
├── Deploy/
52+
└── Experimental/
53+
├── Configuration Loaders/
54+
└── Advanced Features/
3455
Examples/
3556
API Reference/
3657
```
@@ -39,23 +60,25 @@ API Reference/
3960

4061
### Navigation Integration
4162

42-
The experimental section will be integrated as a top-level navigation item, positioned between "User Guide" and "Examples" to maintain logical flow:
63+
The experimental section will be integrated under the "User Guide" section, positioned after "Deploy" to maintain logical flow while keeping experimental features within the main user guide structure:
4364

4465
```yaml
4566
nav:
46-
- User Guide: [existing structure]
47-
- Experimental:
48-
- Overview: experimental/README.md
49-
- Configuration Loaders:
50-
- Overview: experimental/config-loader/overview.md
51-
- Agent Configuration: experimental/config-loader/agent-config.md
52-
- Tool Configuration: experimental/config-loader/tool-config.md
53-
- Swarm Configuration: experimental/config-loader/swarm-config.md
54-
- Graph Configuration: experimental/config-loader/graph-config.md
55-
- Structured Output Configuration: experimental/config-loader/structured-output.md
56-
- Advanced Features:
57-
- Schema Registry: experimental/advanced/schema-registry.md
58-
- Dynamic Model Creation: experimental/advanced/dynamic-models.md
67+
- User Guide:
68+
- [existing sections]
69+
- Deploy: [existing deploy structure]
70+
- Experimental:
71+
- Overview: experimental/README.md
72+
- Configuration Loaders:
73+
- Overview: experimental/config-loader/overview.md
74+
- Agent Configuration: experimental/config-loader/agent-config.md
75+
- Tool Configuration: experimental/config-loader/tool-config.md
76+
- Swarm Configuration: experimental/config-loader/swarm-config.md
77+
- Graph Configuration: experimental/config-loader/graph-config.md
78+
- Structured Output Configuration: experimental/config-loader/structured-output.md
79+
- Advanced Features:
80+
- Schema Registry: experimental/advanced/schema-registry.md
81+
- Dynamic Model Creation: experimental/advanced/dynamic-models.md
5982
- Examples: [existing structure]
6083
- API Reference: [existing structure]
6184
```
@@ -777,31 +800,31 @@ result = agent.extract_userprofile(prompt) # Auto-generated method
777800
778801
## Implementation Timeline
779802
780-
### Phase 1: Foundation (Week 1-2)
781-
- [ ] Create experimental section structure
782-
- [ ] Write experimental overview and guidelines
783-
- [ ] Set up navigation and basic pages
784-
- [ ] Create initial configuration loader overview
785-
786-
### Phase 2: Core Documentation (Week 2-4)
787-
- [ ] Agent configuration guide with examples
788-
- [ ] Tool configuration guide with MCP integration
789-
- [ ] Basic swarm configuration documentation
790-
- [ ] Simple graph configuration examples
791-
792-
### Phase 3: Advanced Features (Week 4-6)
793-
- [ ] Structured output configuration guide
794-
- [ ] Advanced swarm patterns and examples
795-
- [ ] Complex graph workflows and conditional routing
796-
- [ ] Schema registry and dynamic model documentation
797-
798-
### Phase 4: Polish and Integration (Week 6-7)
799-
- [ ] Cross-reference integration with stable docs
800-
- [ ] Migration guides from programmatic approaches
801-
- [ ] Comprehensive example collection
802-
- [ ] Review and editing for consistency
803-
804-
### Phase 5: Community and Feedback (Week 7-8)
803+
### Phase 1: Foundation (COMPLETED)
804+
- [x] Create experimental section structure
805+
- [x] Write experimental overview and guidelines
806+
- [x] Set up navigation and basic pages
807+
- [x] Create initial configuration loader overview
808+
809+
### Phase 2: Core Documentation (COMPLETED)
810+
- [x] Agent configuration guide with examples
811+
- [x] Tool configuration guide with MCP integration
812+
- [x] Basic swarm configuration documentation
813+
- [x] Simple graph configuration examples
814+
815+
### Phase 3: Advanced Features (COMPLETED)
816+
- [x] Structured output configuration guide
817+
- [x] Advanced swarm patterns and examples
818+
- [x] Complex graph workflows and conditional routing
819+
- [x] Schema registry and dynamic model documentation
820+
821+
### Phase 4: Polish and Integration (COMPLETED)
822+
- [x] Cross-reference integration with stable docs
823+
- [x] Migration guides from programmatic approaches
824+
- [x] Comprehensive example collection
825+
- [x] Review and editing for consistency
826+
827+
### Phase 5: Community and Feedback (ONGOING)
805828
- [ ] Community review and feedback incorporation
806829
- [ ] Tutorial videos and interactive examples
807830
- [ ] FAQ and troubleshooting sections

mkdocs.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -125,15 +125,15 @@ nav:
125125
- Amazon Bedrock AgentCore : user-guide/deploy/deploy_to_bedrock_agentcore.md
126126
- Amazon EKS: user-guide/deploy/deploy_to_amazon_eks.md
127127
- Amazon EC2: user-guide/deploy/deploy_to_amazon_ec2.md
128-
- Experimental:
129-
- Overview: experimental/README.md
130-
- Configuration Loaders:
131-
- Overview: experimental/config-loader/overview.md
132-
- Agent Configuration: experimental/config-loader/agent-config.md
133-
- Tool Configuration: experimental/config-loader/tool-config.md
134-
- Swarm Configuration: experimental/config-loader/swarm-config.md
135-
- Graph Configuration: experimental/config-loader/graph-config.md
136-
- Structured Output Configuration: experimental/config-loader/structured-output.md
128+
- Experimental:
129+
- Overview: experimental/README.md
130+
- Configuration Loaders:
131+
- Overview: experimental/config-loader/overview.md
132+
- Agent Configuration: experimental/config-loader/agent-config.md
133+
- Tool Configuration: experimental/config-loader/tool-config.md
134+
- Swarm Configuration: experimental/config-loader/swarm-config.md
135+
- Graph Configuration: experimental/config-loader/graph-config.md
136+
- Structured Output Configuration: experimental/config-loader/structured-output.md
137137
- Examples:
138138
- Overview: examples/README.md
139139
- CLI Reference Agent Implementation: examples/python/cli-reference-agent.md

0 commit comments

Comments
 (0)