docs: add macOS install guide#10
Conversation
TheNorthStarYang
left a comment
There was a problem hiding this comment.
Thanks for the contribution! The macOS install guide is helpful and the commands/paths look generally aligned with the current project structure.
However, we’re trying to avoid adding platform-specific full install guides under the top-level docs/ directory, because it can easily create multiple sources of truth and make the documentation harder to maintain over time.
For this repository, we’d like to keep:
docs/installation.mdas the repo-level install/build entry pointplatforms/macos/README.mdas the macOS platform overviewplatforms/macos/client/README.mdas the main source of truth for macOS client build and packaging instructions
So instead of adding a new docs/install-macos.md, could you please update the existing docs by either:
- adding a short macOS entry/link in
docs/installation.md, or - improving/linking to
platforms/macos/client/README.mdfor the detailed macOS client instructions?
This is mainly about keeping the documentation structure clean and avoiding doc drift. Thanks again for helping improve the project!
For now, I’ll hold off on merging this PR until the macOS guide is moved or consolidated into the existing documentation structure.
|
Thanks for the review. I removed Changes made:
This keeps the macOS guidance within the existing repo layout instead of a standalone top-level install page. |
Closes #3