docs: documentation overhaul and technical corrections #200
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
betterclever
changed the title
- Add file location guide and ID naming conventions - Document ExecutionContext services (logger, secrets, artifacts) - Add error handling section with SDK error types - Add testing section (unit, integration, E2E patterns) - Remove content duplicated in isolated-volumes.mdx - Fix metadata section syntax error - Keep important Docker/PTY patterns and decision tree Signed-off-by: betterclever <paliwal.pranjal83@gmail.com>
- Refactor AGENTS.md to be concise with essential commands - Add architecture overview with data flow diagram - Create .claude/skills/ directory for modular skills - Add component-development skill with agent-focused instructions - Remove .claude/ from .gitignore to track skills - Use openskills XML format for skill discovery Signed-off-by: betterclever <paliwal.pranjal83@gmail.com>
Content now covered in: - docs/development/component-development.mdx - docs/development/isolated-volumes.mdx - .claude/skills/component-development/SKILL.md Signed-off-by: betterclever <paliwal.pranjal83@gmail.com>
- Complete rewrite of architecture.mdx with accurate components and diagrams - Simplify component registry diagram to 4 major categories - Document correct service adapters and infrastructure stack - Remove it-automation/it_ops categories from all docs and skills Signed-off-by: betterclever <paliwal.pranjal83@gmail.com>
- Create dedicated docs/architecture/human-in-the-loop.mdx - Explain block/resume scenario via Temporal signals - Add sequence diagram for manual resolution - Update architecture.mdx with Local Auth details and HITL link Signed-off-by: betterclever <paliwal.pranjal83@gmail.com>
… accurate streaming logic Signed-off-by: betterclever <paliwal.pranjal83@gmail.com>
Signed-off-by: betterclever <paliwal.pranjal83@gmail.com>
Signed-off-by: betterclever <paliwal.pranjal83@gmail.com>
betterclever
force-pushed
the
betterclever/docs-overhaul
branch
from
18c1d75 to
bb1154d
Compare
betterclever
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR performs a comprehensive cleanup and technical audit of the platform's documentation to ensure it accurately reflects the codebase implementation.
Key Enhancements:
Verified against the current system architecture and security implementation.