Contributing to Wiki

This wiki is built with Vitepress.

You can find the wiki files in the dotfiles-installer repo.

If you want to contribute to this site, you can fork the repo, make your changes, and submit a PR.

For building the docs locally:

You need to install bun from the official Bun site.

First, install dependencies:

bun install

Initialize with Vitepress:

bun add -D vitepress

Run the dev server to view real-time changes:

bun run docs:dev

If you want to test the build, you can do:

bun run docs:build

To preview:

bun run docs:preview

Make sure your changes don’t introduce any errors. Test everything properly on your machine before submitting a PR.

Guidelines

If your changes add something to the docs (like a new guide, missing section or any typo fixes), please make sure it's accurate and clearly written in clean Markdown.

Also, I request you not to rewrite or fully write things using LLMs.

Please we don't want to see em dashes here.

We want the docs to be clean & minimal so please follow these guidelines.

Thank you for your support.