diff --git a/README.md b/README.md index 17b69b4f..5a9a0d81 100644 --- a/README.md +++ b/README.md @@ -60,41 +60,6 @@ You can always report problems or help improve bitcoin.org by opening a [new iss [full node page]: https://bitcoin.org/en/full-node [write new documentation]: #developer-documentation -## Developer Documentation - -Most parts of the documentation can be found in the [_includes](https://github.com/bitcoin-dot-org/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 -[mailing list](https://groups.google.com/forum/#!forum/bitcoin-documentation). - -**TODO List**: New content and suggestions for improvements can be submitted -to the [TODO list](https://github.com/bitcoin-dot-org/bitcoin.org/wiki/Documentation-TODO). -You are also welcome if you want to assign yourself to any task. - -**Style Guide**: For better consistency, the [style guide](https://github.com/bitcoin-dot-org/bitcoin.org/wiki/Documentation-Style-Guide) -can be used as a reference for terminology, style and formatting. Suggested changes -can also be submitted to this guide to keep it up to date. - -**Cross-Reference Links**: Cross-reference links can be defined in -_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 diff --git a/docs/contributing-to-developer-documentation.md b/docs/contributing-to-developer-documentation.md new file mode 100644 index 00000000..e61734f2 --- /dev/null +++ b/docs/contributing-to-developer-documentation.md @@ -0,0 +1,42 @@ +## Developer Documentation + +Most parts of the documentation can be found in the +[_includes](https://github.com/bitcoin-dot-org/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 +[mailing list](https://groups.google.com/forum/#!forum/bitcoin-documentation). + +**TODO List**: New content and suggestions for improvements can be submitted +to the [TODO +list](https://github.com/bitcoin-dot-org/bitcoin.org/wiki/Documentation-TODO). +You are also welcome if you want to assign yourself to any task. + +**Style Guide**: For better consistency, the [style +guide](https://github.com/bitcoin-dot-org/bitcoin.org/wiki/Documentation-Style-Guide) +can be used as a reference for terminology, style and formatting. Suggested +changes +can also be submitted to this guide to keep it up to date. + +**Cross-Reference Links**: Cross-reference links can be defined in +_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. + +**Questions?** +Contact Will Binns for help.