Skip to content

Commit 56ae09a

Browse files
rysweetclaude
andauthored
feat(docs): Add documentation website links to README (#1638)
Add prominent link to documentation website at top of README and update all feature documentation links to point to GitHub Pages site instead of internal file paths. Changes: - Added prominent docs website link at line 6 - Updated 31 documentation links to point to https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/ - Converted all docs/ paths to full GitHub Pages URLs including anchors - Maintained all link text and descriptions Fixes #1636 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
1 parent e0e062f commit 56ae09a

File tree

1 file changed

+66
-51
lines changed

1 file changed

+66
-51
lines changed

README.md

Lines changed: 66 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
Development framework for Claude Code with specialized agents and automated
44
workflows.
55

6+
**📚
7+
[View Full Documentation](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/)**
8+
69
```sh
710
uvx --from git+https://github.com/rysweet/MicrosoftHackathon2025-AgenticCoding amplihack launch
811
```
@@ -58,7 +61,7 @@ Launches Claude Code with preconfigured agents. No installation needed.
5861
- uv ([astral.sh/uv](https://docs.astral.sh/uv/))
5962

6063
For detailed installation instructions, see
61-
[docs/PREREQUISITES.md](docs/PREREQUISITES.md).
64+
[docs/PREREQUISITES.md](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/PREREQUISITES/).
6265

6366
### Basic Usage
6467

@@ -171,16 +174,16 @@ variables or secure key management systems.
171174
### GitHub Copilot CLI
172175

173176
amplihack also supports GitHub Copilot CLI integration. See
174-
[docs/github-copilot-litellm-integration.md](docs/github-copilot-litellm-integration.md)
177+
[docs/github-copilot-litellm-integration.md](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/github-copilot-litellm-integration/)
175178
for setup instructions.
176179

177180
### Custom Workflows
178181

179182
The iterative-step workflow is fully customizable. Edit
180183
`.claude/workflow/DEFAULT_WORKFLOW.md` to modify the development process -
181184
changes apply immediately to `/ultrathink` and other commands. See
182-
[docs/WORKFLOW_COMPLETION.md](docs/WORKFLOW_COMPLETION.md) for detailed
183-
customization instructions.
185+
[docs/WORKFLOW_COMPLETION.md](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/WORKFLOW_COMPLETION/)
186+
for detailed customization instructions.
184187

185188
## Commands Reference
186189

@@ -270,8 +273,9 @@ effectiveness. This enables:
270273
- Philosophy compliance checking
271274

272275
**Benchmark results:** Amplihack without orchestration = vanilla Claude. The
273-
orchestration IS the value! See [benchmarking guide](docs/BENCHMARKING.md) for
274-
measuring performance.
276+
orchestration IS the value! See
277+
[benchmarking guide](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/BENCHMARKING/)
278+
for measuring performance.
275279

276280
**Opt-out for simple tasks:**
277281

@@ -319,7 +323,8 @@ python main.py
319323
- Multi-phase execution planning
320324
- Standalone, distributable agents
321325

322-
**Learn more:** [Goal Agent Generator Guide](docs/GOAL_AGENT_GENERATOR_GUIDE.md)
326+
**Learn more:**
327+
[Goal Agent Generator Guide](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/GOAL_AGENT_GENERATOR_GUIDE/)
323328

324329
### Profile Management
325330

@@ -346,7 +351,8 @@ amplihack launch
346351
- `coding`: Development-focused (9 agents)
347352
- `research`: Investigation-focused (7 agents)
348353

349-
**Learn more:** [Profile Management Guide](docs/PROFILE_MANAGEMENT.md)
354+
**Learn more:**
355+
[Profile Management Guide](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/PROFILE_MANAGEMENT/)
350356

351357
### GitHub Pages Documentation Generation
352358

@@ -360,26 +366,27 @@ amplihack launch
360366

361367
**Learn more:**
362368

363-
- [Tutorial: Your First Documentation Site](docs/tutorials/first-docs-site.md)
364-
- [How-To: Generate GitHub Pages Sites](docs/howto/github-pages-generation.md)
365-
- [API Reference: GitHub Pages Module](docs/reference/github-pages-api.md)
369+
- [Tutorial: Your First Documentation Site](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/tutorials/first-docs-site/)
370+
- [How-To: Generate GitHub Pages Sites](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/howto/github-pages-generation/)
371+
- [API Reference: GitHub Pages Module](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/reference/github-pages-api/)
366372

367373
### Additional Features
368374

369-
- **[Power-Steering](docs/reference/STATUSLINE.md#power-steering)** - AI-powered
370-
session guidance with intelligent redirect detection (🚦 indicator)
371-
- **[Auto Mode](docs/AUTO_MODE.md)** - Autonomous agentic loops for multi-turn
372-
workflows (`/amplihack:auto`)
373-
- **[Lock Mode](docs/reference/STATUSLINE.md#lock-mode)** - Continuous work mode
374-
without stopping (`/amplihack:lock`, `/amplihack:unlock`) (🔒 indicator)
375-
- **[Document-Driven Development](docs/document_driven_development/README.md)** -
375+
- **[Power-Steering](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/reference/STATUSLINE/#power-steering)** -
376+
AI-powered session guidance with intelligent redirect detection (🚦 indicator)
377+
- **[Auto Mode](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/AUTO_MODE/)** -
378+
Autonomous agentic loops for multi-turn workflows (`/amplihack:auto`)
379+
- **[Lock Mode](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/reference/STATUSLINE/#lock-mode)** -
380+
Continuous work mode without stopping (`/amplihack:lock`, `/amplihack:unlock`)
381+
(🔒 indicator)
382+
- **[Document-Driven Development](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/document_driven_development/README/)** -
376383
Systematic methodology for large features with documentation-first approach
377384
- **[Fault-Tolerant Workflows](CLAUDE.md#fault-tolerance-patterns)** - N-version
378385
programming, multi-agent debate, and cascade fallback patterns
379386
- **[Security Analysis](CLAUDE.md#key-commands)** - XPIA cross-prompt injection
380387
defense (`/amplihack:xpia`)
381-
- **[Neo4j Memory System](docs/AGENT_MEMORY_QUICKSTART.md)** - Persistent memory
382-
and knowledge graphs across sessions
388+
- **[Neo4j Memory System](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/AGENT_MEMORY_QUICKSTART/)** -
389+
Persistent memory and knowledge graphs across sessions
383390
- **[Investigation Workflow](CLAUDE.md#investigation-workflow)** - Deep
384391
knowledge excavation with historical context
385392
- **[Skills System](.claude/skills/README.md)** - 54+ skills including PDF,
@@ -425,20 +432,24 @@ Real-time session information displayed at the bottom of Claude Code showing:
425432
```
426433

427434
**Full documentation:**
428-
[docs/reference/STATUSLINE.md](docs/reference/STATUSLINE.md)
435+
[docs/reference/STATUSLINE.md](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/reference/STATUSLINE/)
429436

430437
## Documentation
431438

432439
### Getting Started
433440

434-
- [Prerequisites](docs/PREREQUISITES.md) - Platform setup and dependencies
435-
- [Proxy Configuration](docs/PROXY_CONFIG_GUIDE.md) - Azure OpenAI proxy setup
441+
- [Prerequisites](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/PREREQUISITES/) -
442+
Platform setup and dependencies
443+
- [Proxy Configuration](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/PROXY_CONFIG_GUIDE/) -
444+
Azure OpenAI proxy setup
436445

437446
### Features
438447

439-
- [Auto Mode](docs/AUTO_MODE.md) - Autonomous agentic loop
440-
- [Agent Bundles](docs/agent-bundle-generator-guide.md) - Custom agent creation
441-
- [GitHub Copilot Integration](docs/github-copilot-litellm-integration.md) -
448+
- [Auto Mode](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/AUTO_MODE/) -
449+
Autonomous agentic loop
450+
- [Agent Bundles](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/agent-bundle-generator-guide/) -
451+
Custom agent creation
452+
- [GitHub Copilot Integration](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/github-copilot-litellm-integration/) -
442453
Copilot CLI support
443454
- [Office Skills](.claude/skills/README.md) - PDF, Excel, Word, and PowerPoint
444455
document processing
@@ -447,52 +458,56 @@ Real-time session information displayed at the bottom of Claude Code showing:
447458
formulas and financial modeling
448459
- [Azure DevOps CLI Skill](.claude/skills/azure-devops-cli/README.md) - Expert
449460
guidance for Azure DevOps automation, pipelines, boards, repos, and artifacts
450-
- [Benchmarking with eval-recipes](docs/BENCHMARKING.md) - Performance
451-
measurement and comparison
452-
- [Profile Management](docs/PROFILE_MANAGEMENT.md) - Token optimization and
453-
environment customization
461+
- [Benchmarking with eval-recipes](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/BENCHMARKING/) -
462+
Performance measurement and comparison
463+
- [Profile Management](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/PROFILE_MANAGEMENT/) -
464+
Token optimization and environment customization
454465

455466
### Patterns
456467

457-
- [Workspace Pattern](docs/WORKSPACE_PATTERN.md) - Multi-project organization
458-
with git submodules
468+
- [Workspace Pattern](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/WORKSPACE_PATTERN/) -
469+
Multi-project organization with git submodules
459470

460471
### Configuration
461472

462-
- [Hook Configuration](docs/HOOK_CONFIGURATION_GUIDE.md) - Session hooks
463-
- [Workflow Customization](docs/WORKFLOW_COMPLETION.md) - Process customization
473+
- [Hook Configuration](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/HOOK_CONFIGURATION_GUIDE/) -
474+
Session hooks
475+
- [Workflow Customization](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/WORKFLOW_COMPLETION/) -
476+
Process customization
464477

465478
### Development
466479

467-
- [Developing amplihack](docs/DEVELOPING_AMPLIHACK.md) - Contributing guide
468-
- [Implementation Summary](docs/IMPLEMENTATION_SUMMARY.md) - Architecture
469-
overview
480+
- [Developing amplihack](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/DEVELOPING_AMPLIHACK/) -
481+
Contributing guide
482+
- [Implementation Summary](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/IMPLEMENTATION_SUMMARY/) -
483+
Architecture overview
470484

471485
### Methodology
472486

473-
- [Document-Driven Development](docs/document_driven_development/README.md) -
487+
- [Document-Driven Development](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/document_driven_development/README/) -
474488
Systematic approach for large features
475-
- [DDD Overview](docs/document_driven_development/overview.md) - Comprehensive
476-
guide to DDD principles
477-
- [Core Concepts](docs/document_driven_development/core_concepts/README.md) -
489+
- [DDD Overview](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/document_driven_development/overview/) -
490+
Comprehensive guide to DDD principles
491+
- [Core Concepts](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/document_driven_development/core_concepts/README/) -
478492
Context poisoning, file crawling, retcon writing
479-
- [DDD Phases](docs/document_driven_development/phases/README.md) - Step-by-step
480-
implementation guide
493+
- [DDD Phases](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/document_driven_development/phases/README/) -
494+
Step-by-step implementation guide
481495

482496
### Security
483497

484-
- [Security Recommendations](docs/SECURITY_RECOMMENDATIONS.md) - Best practices
485-
- [Security Context Preservation](docs/SECURITY_CONTEXT_PRESERVATION.md) -
498+
- [Security Recommendations](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/SECURITY_RECOMMENDATIONS/) -
499+
Best practices
500+
- [Security Context Preservation](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/SECURITY_CONTEXT_PRESERVATION/) -
486501
Context handling
487502

488503
### Core Principles
489504

490-
- [The Amplihack Way](docs/THIS_IS_THE_WAY.md) - Effective strategies for
491-
AI-agent development
492-
- [Discoveries](docs/DISCOVERIES.md) - Documented problems, solutions, and
493-
learnings
494-
- [Creating Tools](docs/CREATE_YOUR_OWN_TOOLS.md) - Build custom AI-powered
495-
tools
505+
- [The Amplihack Way](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/THIS_IS_THE_WAY/) -
506+
Effective strategies for AI-agent development
507+
- [Discoveries](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/DISCOVERIES/) -
508+
Documented problems, solutions, and learnings
509+
- [Creating Tools](https://rysweet.github.io/MicrosoftHackathon2025-AgenticCoding/CREATE_YOUR_OWN_TOOLS/) -
510+
Build custom AI-powered tools
496511
- [Philosophy](.claude/context/PHILOSOPHY.md) - Core principles and patterns
497512
- [Workflows](.claude/workflow/DEFAULT_WORKFLOW.md) - Development process
498513

0 commit comments

Comments
 (0)