Re: Developer documentation

2023-05-12 Thread Kevin Rushforth
Not scripts, but yes, the JDK uses pandoc to process their markdown files. I'd prefer not to go down that route at this time. The docs we are talking about can be rendered directly by the GitHub UI. -- Kevin On 5/12/2023 2:00 PM, Andy Goryachev wrote: Looks like JDK uses a different flavor

Re: Developer documentation

2023-05-12 Thread John Hendrikx
Apart from the first line which may have special significance, GitHub renders this nicely enough when you activate the preview. I didn't mean to specifically suggest a special flavor of markdown, just that we should ensure it looks okay on GitHub as that will often be the viewer used. --John

Re: Developer documentation

2023-05-12 Thread John Neffenger
On 5/12/23 12:02 PM, John Hendrikx wrote: The build documentation may be a good candidate to place there as well. I'm all for it. Some of us were in agreement on moving at least the build instructions back in November 2022. See the following thread on the mailing list from a pull request disc

Re: Developer documentation

2023-05-12 Thread Andy Goryachev
Looks like JDK uses a different flavor of markdown: > % Testing the JDK https://github.com/openjdk/jdk/blob/38838b344af00b32251b3141350ba4deb3962d6f/doc/testing.md?plain=1#LL1C18-L1C18 Are there any scripts that process the .md in jdk? -andy From: openjfx-dev on behalf of Marius Hanl Date:

Re: Developer documentation

2023-05-12 Thread Andy Goryachev
I think this is a great idea! Some projects use a separate wiki, but sometimes it backfires when domain name changes or wiki software gets updated. Making certain parts of documentation such as these notes, a part of the code repository not only eliminates these failure modes, but provides addi