Skip to content

This repository serves to provide RISC-V specification authors with Vale rulesets that implement RISC-V International's recommended language and style guidelines.

License

Notifications You must be signed in to change notification settings

riscv-admin/riscv-vale

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Vale for RISC-V documentation

This repository serves to provide RISC-V specification authors with Vale rulesets that implement RISC-V International's recommended language and style guidelines.

Introduction

Vale is a command-line tool that brings code-like linting to prose. RISC-V team uses Vale to implement the rules defined by the Doc-Sig and approved by the TSC.

The rules are outlined in the Authoring and Editing RISC-V Specifications guide.

Installing Vale locally

Follow these steps to install Vale locally.

Running Vale on a GitHub repository

Follow these steps to add and enable Vale to your GitHub repository.

About

This repository serves to provide RISC-V specification authors with Vale rulesets that implement RISC-V International's recommended language and style guidelines.

Resources

License

Stars

Watchers

Forks

Packages

No packages published