apache / apache/lucenenet

The Benefits of Redesigning Apache Lucene.NET Documentation with MyST Markdown

Open
#1,408 1 comment 0 reactions 0 assignees View on GitHub
is:feature
Dominant language
C#
Stars
2.4k
Forks
658
Avg merge
3d 5h
Merged PRs (30d)
9

Description

### Is there an existing issue for this?

- [x] I have searched the existing issues

### Is your feature request related to a problem? Please describe the problem.

# Benefits of Redesigning Apache Lucene.NET Documentation with MyST Markdown

Redesigning the Apache Lucene.NET documentation site with MyST Markdown offers the project modernized authoring, native math/code rendering, and streamlined publishing. It enables highly interactive technical documentation and smooth synchronization with modern developer tools.

### Key Benefits for Apache Lucene.NET

* **Advanced Technical Authoring:** MyST Markdown extends standard Markdown to natively support complex technical content. This includes advanced data tables, footnotes, and inline/block mathematical formulas (highly useful for search scoring and Okapi BM25 algorithms).
* **Highly Interactive Experiences:** MyST compiles content into an Abstract Syntax Tree (AST). This allows it to translate docs into interactive React-based websites, PDFs, or Jupyter Notebook-style computational narratives.
* **Superior Cross-Referencing:** Built-in capabilities for scientific citations, cross-referencing, and rich-preview structured links make it much easier for developers to navigate complex API dependencies, architecture diagrams, and search methodologies.
* **Sphinx & Docs-as-Code Compatibility:** MyST brings the powerful tooling and extensibility of the Sphinx ecosystem to standard Markdown. This allows the Lucene.NET community to maintain clean, readable documentation without sacrificing structural power.
* **Open Technical Community:** By adopting a format built by the Executable Book Project, the team taps into a massive open-source ecosystem. This simplifies the authoring and maintenance processes for contributors.

---

https://mystmd.org/guide/quickstart

https://github.com/jupyter-book

---

So I just went and tested a localhost hot reloading server with the mystmd CLI. So to change to full MyST MD some of the navigation, linking, TOCs would configuring perhaps more. I have never documented C# before but I have recently built two MyST sites. You can boot up an instant live server with `uvx` from the repo root it handles all the dependencies and basically with two commands you can boot up a MyST site:

First run:

```
uvx --from mystmd myst init
```

Then run:

```
uvx --from mystmd myst start
```

The first command will pause and ask a question just enter yes:

Image

### Describe the solution you'd like

A new modern collaborator friendly site

### Additional context

Image
Image
Image
Image
Image
Image
Image

Image
Image

Image

Contributor guide

Open the contributing guide

Research direction

Start at the repository root and run the mentioned mystmd commands, `uvx --from mystmd myst init` and `uvx --from mystmd myst start`, to inspect the proposed local site workflow. Review how navigation, linking, and TOCs would need configuring; done would require an agreed migration scope and a working modern documentation site.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.