Skip to content

docs(readme): link to the published documentation site #38

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
fnayou merged 1 commit into from
Jun 25, 2026
Merged

docs(readme): link to the published documentation site #38

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: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ macOS is the primary environment; Arch is supported from the start. Configs are
in `stow/common/` and only ever symlinked into `$HOME` by a **deliberate, manual** Stow step —
never automatically.

📖 **Documentation site:** <https://fnayou.github.io/dotfiles/>

## Status

```
Expand Down Expand Up @@ -38,6 +40,9 @@ reserved for platform-specific packages and are currently empty.

## Documentation

The public documentation site — overview, installation, features, usage, and reference — lives at
<https://fnayou.github.io/dotfiles/> (built with MkDocs Material from `website/`).

Setup guides are written for a human operator, not for agents.

- [Packages setup](docs/guides/packages-setup.md) — install the tools every package depends on (`git`, `stow`, `go-task`, …).
Expand Down
Loading