Skip to content

docs(platforms): 📝 add platform setup guides - #1

Merged
alsd4git merged 4 commits into
mainfrom
docs/readme-platform-guides
Aug 29, 2026
Merged

docs(platforms): 📝 add platform setup guides#1
alsd4git merged 4 commits into
mainfrom
docs/readme-platform-guides

Conversation

@alsd4git

@alsd4git alsd4git commented Aug 29, 2026

Copy link
Copy Markdown
Owner

Summary

This PR reorganizes the README and adds focused setup guides for Debian/Ubuntu, macOS, and Windows.

  • Document installation, package flows, local overlays, recovery, and verification for each platform.
  • Keep the Windows path clearly marked as preview and describe its current limitations.
  • Reject unsupported Linux distributions before a real run links or copies managed files.
  • Add the la listing command to Bash and Zsh so it matches the documented shell commands.
  • Extend the Ubuntu smoke test to cover la and retain the Bash 3.2 compatibility check.

Validation

  • shellcheck -x on the installer, libraries, shell files, and smoke tests
  • shfmt -d -i 4 -ci -bn on the shell sources
  • ./tests/test-installer-functions.sh
  • ./tests/docker-ubuntu-smoke.sh
  • Alpine guard check confirms unsupported hosts exit before managed-file changes

The intended squash commit title is the PR title above.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Aug 29, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-08-29T00:08:37.946980Z 369bccc PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 369bccc0bd

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/linux.md Outdated
Comment thread README.md
- Reject unsupported Linux distributions before changing managed files.
- Keep dry-run available for compatibility previews.
- Define the la alias in Bash and Zsh and cover it in the Ubuntu smoke test.
@alsd4git alsd4git changed the title Docs/readme platform guides docs(platforms): 📝 add platform setup guides Aug 29, 2026
@alsd4git
alsd4git merged commit f6162d8 into main Aug 29, 2026
11 checks passed
@alsd4git
alsd4git deleted the docs/readme-platform-guides branch August 29, 2026 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant