[GitHub] [lucenenet] NightOwl888 commented on issue #284: Docs - convert java snippets to c#

[GitBox <gi...@apache.org>]

NightOwl888 commented on issue #284:
URL: https://github.com/apache/lucenenet/issues/284#issuecomment-806268971


   @Shazwazza
   
   I have generated a list of the Markdown documents and tailored it to the API docs that we should review for this issue.
   
   However, in the process I noticed that we have demo examples that have been copied into the docs:
   
   - [websites\apidocs\apiSpec\demo\Lucene_Net_Demo_Facet_AssociationsFacetsExample.md](https://github.com/apache/lucenenet/tree/master/websites/apidocs/apiSpec/demo/Lucene_Net_Demo_Facet_AssociationsFacetsExample.md)
   - [websites\apidocs\apiSpec\demo\Lucene_Net_Demo_Facet_DistanceFacetsExample.md](https://github.com/apache/lucenenet/tree/master/websites/apidocs/apiSpec/demo/Lucene_Net_Demo_Facet_DistanceFacetsExample.md)
   - [websites\apidocs\apiSpec\demo\Lucene_Net_Demo_Facet_ExpressionAggregationFacetsExample.md](https://github.com/apache/lucenenet/tree/master/websites/apidocs/apiSpec/demo/Lucene_Net_Demo_Facet_ExpressionAggregationFacetsExample.md)
   - [websites\apidocs\apiSpec\demo\Lucene_Net_Demo_Facet_MultiCategoryListsFacetsExample.md](https://github.com/apache/lucenenet/tree/master/websites/apidocs/apiSpec/demo/Lucene_Net_Demo_Facet_MultiCategoryListsFacetsExample.md)
   - [websites\apidocs\apiSpec\demo\Lucene_Net_Demo_Facet_RangeFacetsExample.md](https://github.com/apache/lucenenet/tree/master/websites/apidocs/apiSpec/demo/Lucene_Net_Demo_Facet_RangeFacetsExample.md)
   - [websites\apidocs\apiSpec\demo\Lucene_Net_Demo_Facet_SimpleFacetsExample.md](https://github.com/apache/lucenenet/tree/master/websites/apidocs/apiSpec/demo/Lucene_Net_Demo_Facet_SimpleFacetsExample.md)
   - [websites\apidocs\apiSpec\demo\Lucene_Net_Demo_Facet_SimpleSortedSetFacetsExample.md](https://github.com/apache/lucenenet/tree/master/websites/apidocs/apiSpec/demo/Lucene_Net_Demo_Facet_SimpleSortedSetFacetsExample.md)
   
   
   I don't know specifically how often we are going to need to update the demos, but having duplicate copies of them doesn't seem like a good idea maintenance-wise. And if we are going to copy them, we are missing the 2 main ones that are [linked from the main "core" overview page](https://lucene.apache.org/core/4_8_0/core/overview-summary.html):
   
   - [IndexFiles.cs](https://github.com/apache/lucenenet/blob/Lucene.Net_4_8_0_beta00013/src/Lucene.Net.Demo/IndexFiles.cs)
   - [SearchFiles.cs](https://github.com/apache/lucenenet/blob/Lucene.Net_4_8_0_beta00013/src/Lucene.Net.Demo/SearchFiles.cs)
   
   Is there some reason why we need to duplicate this code into documents? Ideally, our docs would link to the state of these files at the tag of the release so we wouldn't have extra documents to maintain when the code changes.
   
   Also, where are these documents linked from on the website? I couldn't find any references to them.


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