| Author | DaveJarvis <email> |
|---|---|
| Date | 2025-09-05 02:36:07 GMT-0700 |
| Commit | 81e6c13228f9624c6ccb2dccedc49d1081a956c5 |
| Parent | d8b78be |
| Delta | 10 lines added, 10 lines removed |
| * **Consistency** -- Ensure uniform, high-quality output across documents | ||
| * **Future-proof** -- Plain-text files will be readable long after proprietary formats go obsolete | ||
| -* **Version-control** -- Plain text works seamlessly with version control systems | ||
| +* **Version control** -- Plain text works seamlessly with version control systems | ||
| * **Reproducible** -- Generate the same output using different systems | ||
| * **Focus** -- Write without distraction from formatting concerns |
| -# Quick start | ||
| +# Overview | ||
| -This chapter provides a brief overview of how to use the editor. | ||
| +This chapter describes how to basic editing functionality. | ||
| ## First document |
| By default, all text diagrams are sent to [Kroki](https://kroki.io) for | ||
| -conversion into SVG images. A network connection is required to render | ||
| -all text diagrams. There is a configuration option to change servers and | ||
| -Kroki is open source, so it is possible to keep all source diagrams | ||
| -on premises by setting up a locally hosted image server. | ||
| +conversion into SVG images. A network connection is required to render all text | ||
| +diagrams. There is a configuration option to change servers and Kroki is | ||
| +open-source software, so it is possible to keep all source diagrams on premises | ||
| +by setting up a locally hosted image server. | ||
| ## Text diagrams |
| -# Open source software | ||
| +# Open-source software | ||
| -{{app.title}} is free, open source software. | ||
| +{{app.title}} is free, open-source software. | ||
| ## License | ||
| [https://www.gnu.org/licenses/old-licenses/gpl-2.0.html](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html) | ||
| -## Architecture overview | ||
| +## Software architecture | ||
| [@fig:architecture] illustrates the software's high-level application | ||