lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [lucenenet] Shazwazza commented on issue #396: Idea on how to handle manually editing the docs files while keeping the automated conversion
Date Tue, 02 Mar 2021 22:29:51 GMT

Shazwazza commented on issue #396:
URL: https://github.com/apache/lucenenet/issues/396#issuecomment-789266894


   I think what is easiest is in most cases is to only use override files when namespace documentation
doesn't already exist. Namespace documentation will exist for most namespaces in the lucene.net
project based on how our markdown converter tool works. 
   
   This will be consistent with how the "Improve this doc" button works on the documentation.
When clicking on that button and namespace documentation exists, it will edit the currently
existing file. When namespace documentation doesn't exist already (this is rare), there will
be no "Improve this doc" button. In this case we should use override files. As an example
of such a namespace, see https://lucenenet.apache.org/docs/4.8.0-beta00009/api/analysis-phonetic/Lucene.Net.Analysis.Phonetic.Language.html
   
   There might be some cases where we use override files even if the namespace doc is already
there. I think this can occur only if the updated docs are completely different from the originals.
   
   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



Mime
View raw message