From af29f6855ce13be12375d013451fd57b55f99d68 Mon Sep 17 00:00:00 2001 From: "David A. Harding" Date: Thu, 19 Mar 2015 11:39:48 -0400 Subject: [PATCH] Glossary: Add documentation to README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 03bd2b15..5cfc36de 100644 --- a/README.md +++ b/README.md @@ -220,7 +220,7 @@ environment variables: ## Developer Documentation -Each part of the documentation can be found in the [_includes](https://github.com/bitcoin/bitcoin.org/tree/master/_includes) +Most parts of the documentation can be found in the [_includes](https://github.com/bitcoin/bitcoin.org/tree/master/_includes) directory. Updates, fixes and improvements are welcome and can submitted using [pull requests](#working-with-github) on GitHub. **Mailing List**: General discussions can take place on the @@ -238,6 +238,21 @@ can also be submitted to this guide to keep it up to date. _includes/references.md. Terms which should automatically link to these references are defined in _autocrossref.yaml . +### New Glossary Entries + +Add new English glossary entries in the `_data/glossary/en/` directory. +Copy a previous glossary entry to get the correct YAML variables +(suggest using block.yaml as a template). + +Non-English glossary entries are not currently supported. You'll have +to update the glossary.rb plugin and templates to support them. + +### New Developer Search terms + +You can add new search terms or categories directly to the `devsearches` +array in `_config.yaml`. Comments in that file should provide full +documentation. + ## Translation ### How To Translate