FINERACT-2170: improve asciidoc: clean URIs, more (#4271)

* disable broken fineract-client API asciidoc include
  * this has a side effect of removing ~1,200 pages from the PDF
* remove duplicated/outdated text, reduce sources of truth
  * link to current FAQ
  * introduction is all references now... it was way out of date and also needed formatting fixes
* unset `show-link-uri` to improve PDF rendering
* remove unnecessary/unused `.asciidoctorconfig` file
This commit is contained in:
Adam Monsen
2025-01-29 12:41:34 -06:00
committed by GitHub
parent 66f3de8702
commit 8b80f5a934
7 changed files with 24 additions and 79 deletions
+12 -1
View File
@@ -19,6 +19,11 @@
:doctitle: Fineract Platform Documentation
// Never show URI for named links.
// There's no need as long as all of our output formats are digital (hence, click/touch-able).
// Only applies to PDF backend.
:!show-link-uri:
include::config.adoc[]
= Fineract Documentation
@@ -51,12 +56,18 @@ include::chapters/release/index.adoc[leveloffset=+1]
include::chapters/sdk/index.adoc[leveloffset=+1]
include::fineract-client.adoc[leveloffset=+1]
// Broken: asciidoc is only partially rendered.
//include::fineract-client.adoc[leveloffset=+1]
include::faq.adoc[leveloffset=+1]
include::glossary.adoc[leveloffset=+1]
// See https://docs.asciidoctor.org/asciidoc/latest/sections/user-index/ .
// Limit this to PDF because the HTML backend can't (yet) create an index.
// Also, we don't yet have any indexed terms, so it might make more sense to remove the index even for PDF.
ifdef::backend-pdf[]
include::indices.adoc[leveloffset=+1]
endif::[]
include::chapters/appendix/index.adoc[]