Editing the wiki

Editing the wiki

The Wiki is a separate Git repository. It is simple Markdown and can be edited on the web or from the command line.

Edit on the web

1. Open the IdMux Wiki.
2. Open a page.
3. Click Edit.
4. Make a small change.
5. Add a short edit message.
6. Click Save Page.

Edit with Git

The first page must exist before cloning the Wiki.

gh auth setup-git
git clone https://github.com/4nass/idmux-proxy.wiki.git
cd idmux-proxy.wiki
git config user.name 4nass
git config user.email 4nass@users.noreply.github.com

Edit a Markdown page, then publish it:

git add .
git commit -m "docs: update wiki"
git push origin master

The Wiki does not have the same pull request flow as the main repository. Keep write access limited to trusted contributors. Use issues or a pull request in the main repository when a documentation change needs review.

Allow more editors

For a public repository, GitHub can allow any signed-in GitHub account to edit the Wiki. This is a repository setting. Keep the restriction enabled unless you really need open direct editing.

Writing rules

• Use simple English.
• Use short sentences.
• Add a command when a reader must run something.
• Keep links working.
• Never add secrets, cookies, tokens, keys, or private data.