Github user NightOwl888 commented on the issue:

    https://github.com/apache/lucenenet/pull/206
  
    Thanks. I ended up dividing them into separate documents because it was too 
easy to scroll by the end of the command you are looking at into the next 
command, so that was not needed anyway.
    
    https://github.com/NightOwl888/lucenenet/tree/cli/src/tools/lucene-cli/docs
    
    Let me know if there is anything with this structure that isn't going to 
work. I am working on fixing an issue with the build script that was caused by 
adding this CLI project to the solution, after which I will be able to merge 
this to master. Then I can work on adding the CLI tool to the build script at 
the same time you are working on integrating these Markdown pages into the API 
docs.
    
    To remove the Java CLI info from the original API docs, we should probably 
replace it with a link to the corresponding command (or commands) here in the 
doc comments. Any ideas how that could be done?
    
    We could just remove it from the API docs altogether, but it feels like 
there still needs to be some sort of API document telling you which command a 
class is used in, and on these Markdown docs which class is used by a command. 
So we will need a way to link both directions.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---

Reply via email to