Skip to content

[docs] docs: unbloat MemoryOps guide#23506

Merged
pelikhan merged 1 commit intomainfrom
docs/unbloat-memoryops-58b5ff82f5ecb6d8
Mar 30, 2026
Merged

[docs] docs: unbloat MemoryOps guide#23506
pelikhan merged 1 commit intomainfrom
docs/unbloat-memoryops-58b5ff82f5ecb6d8

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Removes structural bloat from docs/src/content/docs/guides/memoryops.md while preserving all content and examples.

What was removed

All 6 pattern sections repeated an identical 3-label structure:

  • Your goal: ...restates the section title...
  • How to state it in your workflow: label before the code block
  • What the agent will implement: 1-2 sentences restating what was already shown

These labels added friction without adding information. The pattern title + description already convey the goal; the code block speaks for itself.

Also condensed:

  • The "How to Use These Patterns" tip box (removed redundant setup narrative)
  • The Security Considerations section (merged bullet list into prose above the same code example)

Changes

Metric Before After
Lines 301 244
Reduction −19%

All code examples, real-world file references, frontmatter, and section structure are preserved.

Screenshots

Screenshots could not be captured — the docs dev server requires Node.js ≥ 22 (astro dev exits immediately on v20.20.1). No visual regression is expected since only prose and labels were removed from existing sections.

References:

🗜️ Compressed by Documentation Unbloat ·

  • expires on Apr 1, 2026, 3:55 AM UTC

Each of the 6 patterns repeated the same "Your goal" / "How to state it
in your workflow" / "What the agent will implement" label structure.
Removed these labels and condensed prose — content and examples unchanged.
Also tightened the tip box and security considerations section.

301 → 244 lines (−19%).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Mar 30, 2026
@pelikhan pelikhan marked this pull request as ready for review March 30, 2026 04:14
Copilot AI review requested due to automatic review settings March 30, 2026 04:14
@pelikhan pelikhan merged commit ad62f24 into main Mar 30, 2026
1 check passed
@pelikhan pelikhan deleted the docs/unbloat-memoryops-58b5ff82f5ecb6d8 branch March 30, 2026 04:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Removes repetitive scaffolding text from the MemoryOps guide to make the patterns more concise while keeping examples and structure intact.

Changes:

  • Condensed the “How to Use These Patterns” TIP box into a single, direct instruction.
  • Removed repeated “Your goal / How to state it / What the agent will implement” label blocks across all patterns, replacing them with brief connective prose.
  • Simplified the Security Considerations section into a single paragraph above the existing example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Consider encryption for sensitive but non-secret data

**Safe practices**:
Memory stores are visible to anyone with repository access. Never store credentials, API tokens, PII, or secrets — only aggregate statistics and anonymized data.
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previous guidance to "Consider encryption for sensitive but non-secret data" was removed when condensing this section. That advice is still useful (e.g., for customer identifiers or internal metrics) even if secrets are excluded; consider re-adding it as a sentence here so the security guidance remains complete.

Suggested change
Memory stores are visible to anyone with repository access. Never store credentials, API tokens, PII, or secrets — only aggregate statistics and anonymized data.
Memory stores are visible to anyone with repository access. Never store credentials, API tokens, PII, or secrets — only aggregate statistics and anonymized data. For sensitive but non-secret data (such as customer identifiers or internal metrics), consider using encryption in line with your organization's security policies.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants