apache / apache/lucenenet

Docs - Migrate missing QueryParser documentation

Open
#625 0 comments 0 reactions 0 assignees View on GitHub
docs pri:normal up-for-grabs
Dominant language
C#
Stars
2.4k
Forks
658
Avg merge
3d 5h
Merged PRs (30d)
9

Description

There is a [docs folder](https://github.com/apache/lucene/tree/releases/lucene-solr/4.8.1/lucene/queryparser/docs) in the QueryParser of Lucene 4.8.1 that has some files that are not currently being bundled with our API documentation. Some of the docs are in HTML and look like they might be auto-generated, so this needs some investigation.

Contributor guide

Open the contributing guide

Research direction

Compare the lucene/queryparser/docs folder from the Lucene 4.8.1 source with the documentation currently bundled by Lucene.NET. Inspect the HTML files and the API documentation packaging entry point to determine which files are missing or generated. Done means the relevant QueryParser documentation is included in the API documentation bundle.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.