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 #282: Docs - Build/Deploy Automation
Date Thu, 28 May 2020 23:06:43 GMT

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


   Right well if you just want to be able to have pure documentation pages like how-to's then
we just make normal pages and table of contents, just like the normal lucene website. Like
the MS docs you mentioned https://docs.microsoft.com/en-us/aspnet/core/fundamentals/dependency-injection?view=aspnetcore-3.1
these are not based on API generated docs, these are just pages which of course we can do.
If you want to put docs/examples directly into the namespace generated code for namespaces/classes
that is fine too and that is how the current lucene 'overview' files work. Apart from that
though we can just make our own pages do to whatever we want like the website.
   
   > Seems a bit odd that it is not supported, as it is quite common for Microsoft .NET
assemblies to extend namespaces
   
   Yep i know and it's been mentioned a few times in that docfx thread but they aren't responded
to that and I'm unsure what the story is for this for DocFx 3 (or when that is ever released).
The end result though is trying to change the UIDs for namespaces is going to result in huge
changes to everything and I don't really want to go down that rabbit hole since I think the
get that right is going to take weeks of my time. I'm pretty sure I can get the site build
with sub-sites and have it looking/working relatively similar. The challenge from there is
not being able to cross reference a doc by ID between different site builds but I don't think
the lucene docs can do that either. Though at least for that scenario it would be fairly easy
to build a plugin to enhance cross referencing. There's still a bunch of docfx features I'm
investigating for this, it might turn out that there's work arounds for this already.
   


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