docs: add user documentation structure and initial guides - #332
Merged
Conversation
Add ADR 0023 deciding on audience-based documentation split (admin/ vs user/) with writing rules for guides. Create initial guides: - Admin guide for installing fullsend end-to-end - User guide for the bugfix workflow (triage → code → review → merge) The bugfix workflow guide includes planned callouts for the fix agent (#197) and retro agent (#131). Addresses #247. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Site previewPreview: https://2a43d942-site.fullsend-ai.workers.dev Commit: |
Skill covers directory layout, writing rules from ADR 0023, checklist, and references elements-of-style for effective prose. Symlinked into ~/.claude/skills/ for cross-project discovery. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2 tasks
rh-hemartin
added a commit
that referenced
this pull request
Apr 22, 2026
Align with documentation structure from PR #332 (ADR 0023). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
rh-hemartin
added a commit
that referenced
this pull request
Apr 23, 2026
Align with documentation structure from PR #332 (ADR 0023). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Hector Martinez <hemartin@redhat.com>
rh-hemartin
added a commit
that referenced
this pull request
Apr 23, 2026
Align with documentation structure from PR #332 (ADR 0023). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Hector Martinez <hemartin@redhat.com>
rh-hemartin
approved these changes
Apr 23, 2026
gbenhaim
pushed a commit
to gbenhaim/fullsend
that referenced
this pull request
Apr 27, 2026
Align with documentation structure from PR fullsend-ai#332 (ADR 0023). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Hector Martinez <hemartin@redhat.com>
4 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
docs/guides/admin/vsdocs/guides/user/) with writing rules for guidesdocs/guides/user/bugfix-workflow.md) — end-to-end guide for developers covering triage → code → review → merge, with planned callouts for the fix agent (Story 9: Fix Agent #197) and retro agent (Story 8: Feedback Loop into Harness - Retro Agent #131)skills/writing-user-docs/SKILL.md) for consistent guide authoringdocs/guides/README.mdindex and links it from the root READMEThe admin install guide is handled separately in #328 — this PR links to it at the expected path (
docs/guides/admin/installation.md).Closes #247
Test plan
make lintpasses🤖 Generated with Claude Code