Skip to content

docs: add Starship to root README and documentation.md contents #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zaccesss merged 1 commit into from
Jun 5, 2026
Merged

docs: add Starship to root README and documentation.md contents #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,8 @@ dotfiles/
- mirror_tokens_template.ps1 token file template (PowerShell)
- sync-meta.sh syncs repo metadata to all mirror platforms
- guides/ platform setup walkthroughs and command reference
- shared/ platform-agnostic reference documents
- shared/ platform-agnostic files used by all three platforms
- starship.toml Starship prompt config — one file for Mac, Linux and Windows
- journal/ engineering journal: decisions, refactors, architecture notes
- documentation.md full technical reference for every command
```
Expand All @@ -107,6 +108,8 @@ dotfiles/
| [mac/topics/README.md](mac/topics/README.md) | All macOS topic files listed with descriptions and key commands |
| [linux/topics/README.md](linux/topics/README.md) | All Linux topic files listed with descriptions and key commands |
| [windows/topics/README.md](windows/topics/README.md) | All Windows topic files listed with descriptions and key commands |
| [shared/starship.toml](shared/starship.toml) | Starship prompt config — one file for all three platforms, covering git and all 59 topic file languages |
| [journal/009-starship-prompt.md](journal/009-starship-prompt.md) | Why Starship was added, module choices, the shared/ approach and how to disable it |

---

Expand Down
1 change: 1 addition & 0 deletions documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Detailed technical reference for this dotfiles repo. This covers how the loader
- [Blender](#blender)
- [Adobe](#adobe)
- [Productivity](#productivity)
- [Starship prompt](#starship-prompt)
- [Extending the profile](#extending-the-profile)
- [Alias conflict rules](#alias-conflict-rules)

Expand Down