predicate.dev

predicate.dev - A website for software specifications

Create a new specification

• Create a subfolder under the content folder with a short name for your specification. This folder will be used in the url, so make it lowercase, short and representative.
• Create an _index.md file with the full name of the specification

content/sample/_index.md (subsitute sample with the spec foldername)

---
title: "Sample Specification"
---

Front-matter tags in specifications

• title: Shown before any other content in an H1 tag
• version: A Semantic Versioning 2.0.0 compliant version number. Shown directly below the title in an H2 tag
• latest: true or false (default). Used to determine the specification shown when navigating to the specification main URL. At least one specification should be marked as latest, usually the latest release version of the specification

content/sample/1.0.0/index.md (subsitute sample with the spec foldername)

---
Title: "Sample Specification"
version: "1.0.0"
latest: true
---

Content of the specification goes here

Translations

• Check hugo.toml file to see if the language is present in the [languages] section, else add it.
• Note the language abbreviation. We will use fr (French) as an example. In all cases below subsitute fr for your language abbreviation
• Check if i18n/fr.yaml is available, if not copy i18n/en.yaml to i18n/fr.yaml
• Translate the content of i18n/fr.yaml based on i18n/en.yaml as needed.
• Locate the specification file to translate, for example to translate Semantic Version Query Language Specification 1.0.0 copy content/svql/1.0.0/index.md to content/svql/1.0.0/index.fr.md
• Translate the language specific file

Create a pull request with your specfication

• Create a pull request via GitHub and we will consider your submission for approval