rmuir commented on issue #11870: URL: https://github.com/apache/lucene/issues/11870#issuecomment-1373155758
The various overview.html's might even be the easiest ones to think about how markdown could work, rather than package summaries. These are currently maintained as html files, and passed to the javadoc command with `-overview file.html`. Maybe they could be maintained as README.md files instead that get preprocessed to overview.html? I like the idea that browsing lucene/core/src/java just in github would then show the overview automatically, but... all the links to any classes are gonna be broken without support javadoc, so i'm not sure of the value we get from markdown over just keeping them as html. Plus the additional .md->.html indirection would add some complexity over the current files. But I guess possibly it might be easier to contribute to? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
