mirror of
https://github.com/jlengrand/moderne-docs.git
synced 2026-03-10 08:31:21 +00:00
4c57d0cf78
As you can't run test with Java 23¹, it's better to just define the Java version as 17 or 21 in the documentation (and maybe 25 once it's released in September next year). The user reading the documentation does not want to understand the nitty gritty things about OpenRewrite, but wants to run the tests. __ ¹ You will run into a "Failed to parse sources or run recipe => Failed to convert for the following cursor stack" error.
Moderne Docs
The docs behind https://docs.moderne.io/. For OpenRewrite docs, please see the rewrite-docs repository.
Contributing
We encourage you to contribute to our docs! Please feel free to create an issue or open a PR if you find any issues.
We use Docusaurus to manage our documentation. When any changes are merged into this repository, a build is kicked off to update the docs.
Standards
- In document titles and headers, use sentence case. That is, capitalize only the first word in the title, the first word in a subheading after a colon, and any proper nouns or other terms that are always capitalized a certain way. Don't put a period at the end of a title or heading.
- When using acronyms, you must always fully define the acronym before it can be used in the document. For instance, you would say something like: "The North Atlantic Treaty Organization (NATO) did..." Then, in the rest of the document, you can freely use NATO instead.