The DX Tech Papers in this repository are automatically published on the web at https://devpasta.github.io/papates/. To learn more about the purpose of DX Tech Papers and how to write one, please start reading at DX Tech Paper 1. Note that the DX Tech Paper Index (DX Tech Paper 0) is automatically generated based on the metadata headers in other DX Tech Papers.
The canonical form of DX Tech Paper links are zero-padded, such as https://devpasta.github.io/papers/dx-0008/. Shortcut redirects are also available. For example, https://devpasta.github.io/papers/8 redirects to the canonical link.
See the Contributing Guidelines.
Please don't commit changes with reStructuredText syntax errors that cause DX Tech Paper generation to fail or result in major rendering defects relative to what you intend.
For every PR, we automatically create a preview of the rendered DX Tech Papers using ReadTheDocs. You can find it in the merge box at the bottom of the PR page:
- Click "Show all checks" to expand the checks section.
- Find the line for
docs/readthedocs.org:dx-paper-previews. - Click on "Details" to the right.
To render the DX Tech Papers locally, you need Docker 20 or later. Then, run the following command:
# Build and run the Docker container
make serveThe output HTML is found under the _site directory.
You can check for and fix common linting and spelling issues, either on-demand or automatically as you commit, with our pre-commit suite. See the Contributing Guide for details.