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 #229: Updates docs build
Date Tue, 20 Aug 2019 05:46:14 GMT
Shazwazza commented on issue #229: Updates docs build
URL: https://github.com/apache/lucenenet/pull/229#issuecomment-522862913
 
 
   > So, the end user will basically have 4 ways to get the demo code:
   
   > View it on screen with the CLI
   > Export it using the CLI
   > View it on the markdown doc (1:1 - I am hoping to have you automate getting the code
from the .cs files in the repo into the markdown so they stay up to date)
   > They can view the code directly on GitHub
   
   Gotcha. So I'll need to do is: Take all of the *.cs files in the Lucene.Net.Demo project
and automatically output the code into .md files that we can use to directly display this
code in our docs. For example, on this page: https://lucenenetdocs.azurewebsites.net/api/Lucene.Net.Demo/Lucene.Net.Demo.Facet.SimpleFacetsExample.html
... we'd want to have the actual cs code shown there. The user could then still click on "View
Source" to navigate to the source file in GitHub.
   
   Correct? 
   
   If so, we can definitely do that by using the DocFx "overwrite" feature. 

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


With regards,
Apache Git Services

Mime
View raw message