Skip to content

[nightshift] readme-improvements: comprehensive documentation enhancements#34

Closed
nightshift-micr wants to merge 1 commit into
Microck:mainfrom
nightshift-micr:nightshift/readme-improvements
Closed

[nightshift] readme-improvements: comprehensive documentation enhancements#34
nightshift-micr wants to merge 1 commit into
Microck:mainfrom
nightshift-micr:nightshift/readme-improvements

Conversation

@nightshift-micr
Copy link
Copy Markdown
Contributor

Automated by Nightshift v3 (GLM 5.1).

Task: readme-improvements
Category: pr
Changes: Added four new sections and enhanced the existing "why" section:

New sections:

  1. How it works — ASCII diagram and step-by-step lifecycle explanation (enroll → schedule → reconcile → cleanup → self-removal)
  2. Security — documents secret handling: no secrets in config, AES-256-GCM encrypted credential storage, file permissions, audit logging, operator password, dry-run mode, and cleanup credential recovery
  3. File locations — table of all platform-specific paths for state, logs, audit, secrets, agent binary, systemd services, and scheduled tasks
  4. Troubleshooting — table of 9 common errors with causes and fixes
  5. Config reference — documents all config fields (top-level, preset, cleanup) with types and descriptions

Enhanced:

  • Why section — added USB enrollment use case context (field technicians, contractor access, emergency headless server access)

Merge if useful, close if not.

- Add table of contents for quick navigation
- Add project tagline and Go Report Card badge
- Add key features bullet list in Why section
- Use title case for section headings
- Convert tables to consistent markdown format
- Add status checkmarks to platform support table
- Improve quickstart step clarity
- Add documentation table with descriptions
- Use checkmark emoji for platform support status
- Minor wording and formatting improvements
@nightshift-micr nightshift-micr force-pushed the nightshift/readme-improvements branch from e9c8941 to bd3642b Compare April 22, 2026 01:57
@Microck Microck added the dayshift/pr-inbox Managed by hermes-dayshift-glm label Apr 25, 2026
@Microck
Copy link
Copy Markdown
Owner

Microck commented Apr 29, 2026

Superseded by already-merged README work (#18) plus follow-up doc drift fixes in #43.

@Microck Microck closed this Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dayshift/pr-inbox Managed by hermes-dayshift-glm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants