Contribute
This guide is written by people who use Vellum.
Suggest a change
Open an issue if you spot something wrong, have a question, or want to suggest a topic.
Make an edit
- Fork this repo
- Make your change
- Open a pull request saying what changed and, if relevant, how you checked it
- If you added a new page, add it to the sidebar in docs/.vitepress/config.mjs in the same PR
What makes a good page
- Is clear to someone who installed Vellum yesterday
- Shortcuts show the Mac, Windows, and Linux keys separately
- Images and examples often beat lengthy prose (I should take my own advice 😁)
- Plain, human, friendly words are welcome and most appreciated
Say which version you checked against
Every page records the version of Vellum it was checked against at the top of the file:
---
version: "0.1.30"
---
Vellum changes quickly which means pages can often go stale. So ... if you edit a page, set the version to whatever you tested on.
While Vellum is in private beta
Screenshots, tips and how-tos are fine and welcome and awesome. But please no builds, installers, invite links, etc.
Credit
Every page shows who wrote it, plus there's a contributors page. The writing here is under Creative Commons Attribution, so it can be reused anywhere, including on vellumnotes.app, as long as contributors are credited.