mirror of
https://github.com/seigler/dash-docs
synced 2025-07-27 09:46:12 +00:00
Glossary: Add documentation to README.md
This commit is contained in:
parent
801ea9f4ad
commit
af29f6855c
1 changed files with 16 additions and 1 deletions
17
README.md
17
README.md
|
@ -220,7 +220,7 @@ environment variables:
|
||||||
|
|
||||||
## Developer Documentation
|
## 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.
|
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
|
**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
|
_includes/references.md. Terms which should automatically link to these
|
||||||
references are defined in _autocrossref.yaml .
|
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
|
## Translation
|
||||||
|
|
||||||
### How To Translate
|
### How To Translate
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue