docs: Condense locals documentation by 60% for clarity#2000
Merged
aknysh merged 1 commit intoaknysh/fix-locals-5from Jan 21, 2026
Merged
docs: Condense locals documentation by 60% for clarity#2000aknysh merged 1 commit intoaknysh/fix-locals-5from
aknysh merged 1 commit intoaknysh/fix-locals-5from
Conversation
- Reduced stacks/locals.mdx from 827 to 331 lines (60% cut)
- Consolidated Configuration Scopes (3 examples → 1 comprehensive example)
- Moved Processing Order diagram to <details> block ("How does processing work?")
- Deleted redundant "Complete Example" section, rely on "Try It" embed instead
- Removed duplicate explanations of file-scoped isolation across sections
- Moved debugging output examples to <details> block
- Condensed error handling section and best practices
- Removed "Scope Merging", "Limitations", "When to Use Each" sections as redundant
- Reduced examples/locals/README.md from 155 to 35 lines (77% cut)
- Aligned with standard example README pattern (demo-stacks/README.md style)
- Removed 60-line "Example Output" section
- Removed 40-line "Key Concepts" section duplicating main docs
- Fixed broken documentation link (/core-concepts/stacks/locals → /stacks/locals)
Locals is a minor feature with key gotchas. Documentation now appropriately sized.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Dependency Review✅ No vulnerabilities or license issues found.Scanned FilesNone |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## aknysh/fix-locals-5 #2000 +/- ##
=======================================================
- Coverage 74.97% 74.94% -0.03%
=======================================================
Files 775 775
Lines 71427 71456 +29
=======================================================
+ Hits 53550 53554 +4
- Misses 14393 14416 +23
- Partials 3484 3486 +2
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
aknysh
approved these changes
Jan 21, 2026
aknysh
added a commit
that referenced
this pull request
Jan 21, 2026
…le. Add `locals` design patterns. Add Atmos YAML functions support in `locals` (#1994) * fix locals * fix locals * [autofix.ci] apply automated fixes * address comments * improve docs, add example for `locals` * [autofix.ci] apply automated fixes * address comments * update docs * address comments, update docs, add tests for locals example, add locals design patterns, add blog post * address comments, update docs, add tests * address comments, update docs, add tests * address comments, update docs, add tests * address comments, update docs, add tests * address comments * update docs * update docs * fix: Align diagram with numbered steps and add missing periods - Update mermaid diagram to show template processing as step 4 after merge - Remove step 3 from per-file boxes (templates processed after merge) - Add periods to list items in troubleshooting section for consistency Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * update docs * update docs * update docs * update docs and example * update docs and example * locals with Atmos YAML functions, update docs, add tests, add blog posts * update roadmap * address comments, add tests * update docs * docs: Condense locals documentation by 60% for clarity (#2000) - Reduced stacks/locals.mdx from 827 to 331 lines (60% cut) - Consolidated Configuration Scopes (3 examples → 1 comprehensive example) - Moved Processing Order diagram to <details> block ("How does processing work?") - Deleted redundant "Complete Example" section, rely on "Try It" embed instead - Removed duplicate explanations of file-scoped isolation across sections - Moved debugging output examples to <details> block - Condensed error handling section and best practices - Removed "Scope Merging", "Limitations", "When to Use Each" sections as redundant - Reduced examples/locals/README.md from 155 to 35 lines (77% cut) - Aligned with standard example README pattern (demo-stacks/README.md style) - Removed 60-line "Example Output" section - Removed 40-line "Key Concepts" section duplicating main docs - Fixed broken documentation link (/core-concepts/stacks/locals → /stacks/locals) Locals is a minor feature with key gotchas. Documentation now appropriately sized. Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com> * update tests * address comments --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>
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.
what
website/docs/stacks/locals.mdxfrom 827 to 331 lines (60% reduction)examples/locals/README.mdfrom 155 to 35 lines (77% reduction)<details>blockswhy
references
settings,vars, andenvfrom the same file. Addlocalsdesign patterns. Add Atmos YAML functions support inlocals#1994