â›… Coming soon: create Unison Cloud clusters in minutes on your own infrastructure. Learn more

📃 Contribute to the Docs

The Unison language website is written in Unison's own computable documentation format!

If you have suggestions, fixes, or feedback for the language documentation content, you can file a Unison Share ticket in the website Unison Share repo. The content is hosted on Unison Share in the @unison/website project, while the Github website repo houses the front end used for styling and rendering the documentation.

PR's are also welcome! To submit a PR for doc content, you'll need to follow the PR process.

Steps

  1. scratch/main> clone @unison/website to create a local copy of the website.
  2. @unison/website/main> branch @user/feature to create a contributor branch of the website.
  3. If you haven't already done so, set your default author.
  4. Now edit desiredTerm and hack away. When you're ready, update your codebase to add the term.
  5. Important! If your change requires linking back and forth between two docs, the UCM will not permit the doc cycle to be created. This is for good reasons. Instead, one of the docs links will need to be a relative url path link, like this [my doc reference](./path-to-doc). You can test your link by building the website locally.
  6. Push your branch to Unison Share and follow the instructions to create a contribution.
  7. Finally mention your PR in the #documentation channel in the Unison slack.