Skip to content

📖 [Docs]: Context README is now a complete landing page with concepts and usage#120

Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
mainfrom
docs/standardize-readme
Open

📖 [Docs]: Context README is now a complete landing page with concepts and usage#120
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
mainfrom
docs/standardize-readme

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 6, 2026

Copy link
Copy Markdown
Member

The Context README is now a complete landing page. It explains what a context is, how contexts are grouped into encrypted vaults, and how to store and retrieve data — so users and module authors can understand and adopt the module without leaving the page.

What changed

  • Restored the conceptual overview — "What is a context?" describes the model, SecureString handling, and how Get-ContextInfo exposes metadata without decrypting.
  • Restored the vaults model — including the $HOME/.contextvaults/<VaultName>/ directory-structure diagram and the isolation guarantees between vaults.
  • Restored the encryption note — Context encrypts data at rest with NaCl via the Sodium module, installed automatically.
  • Added a ## Usage showcase — a Set-Context / Get-Context round-trip plus metadata inspection and vault/context management, all using real exported commands.
  • Trimmed the developer guide — the long "Implementation Guide for Module Developers" is condensed to the unique quick-start, wrapper pattern, and key points; content that merely duplicated command help was dropped.
  • Standardized installation — uses Install-PSResource -Name Context.
  • Removed the ## Contributing section.

Technical details

  • Updates README.md only.
  • Aligns with the PSModule landing-page standard while preserving the conceptual material this feature-rich module needs.
  • Command-by-command reference remains in PowerShell help and the generated docs at psmodule.io/Context.

Copilot AI review requested due to automatic review settings July 6, 2026 06:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR standardizes README.md into a lightweight landing page for the Context PowerShell module, shifting detailed usage guidance to PowerShell help and the generated documentation site.

Changes:

  • Replaced the long-form README content with a short module summary and minimal usage entry points.
  • Simplified installation instructions and added a dedicated documentation section pointing to psmodule.io.
  • Added contributing guidance pointing readers to the issue tracker.

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

Comment thread README.md
Comment thread README.md Outdated
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Docs: standardize README 📖 [Docs]: README pages now use the standard module landing-page format Jul 6, 2026
Copilot AI review requested due to automatic review settings July 12, 2026 10:00
@MariusStorhaug Marius Storhaug (MariusStorhaug) added the documentation Improvements or additions to documentation label Jul 12, 2026
@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title 📖 [Docs]: README pages now use the standard module landing-page format 📖 [Docs]: Context README is now a complete landing page with concepts and usage Jul 12, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread README.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread README.md
@github-actions

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants