lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From NightOwl888 <...@git.apache.org>
Subject [GitHub] lucenenet issue #206: API Doc site generator using DocFx script
Date Fri, 07 Jul 2017 05:27:06 GMT
Github user NightOwl888 commented on the issue:

    https://github.com/apache/lucenenet/pull/206
  
    Much appreciated - keep up the good work 👍
    
    I am almost to the point where I will start documenting the [new CLI tool](https://github.com/NightOwl888/lucenenet/tree/cli/src/tools).
Originally, I was thinking about making 1 page per command like Microsoft did on their [dotnet
tool](https://docs.microsoft.com/en-us/dotnet/core/tools/), but there isn't quite enough here
for all of that. It would be easier to have 1 document for each of the 4 subcommands and a
small section below for each command + 1 overview document describing the tool in general
(so 5 pages of docs).
    
    This tool contains all of the index maintenance tasks (checking, fixing, upgrading, splitting,
merging, moving segments around, etc.) plus a set of demos that can be run, and source code
viewed, or exported. The plan is to put this tool on Chocolatey so it can be easily installed
and updated, as well as make it part of the CI release process.
    
    Would building the docs in Markdown and placing them in a subdirectory of tools be appropriate,
or would something else work better?
    
    > but that is optional but the links between pages should be updated to markdowns since
that's much easier to generate the links.
    
    This is one point that is a bit unclear to me. In the past I have tried to make links
between pages on GitHub and they didn't always work - I ended up using absolute URLs to avoid
the problems (but I don't recall exactly what they were). Do you have a suggestion about the
*correct* way to make relative links between Markdown pages?


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message