quickwit-oss / quickwit-oss/quickwit
Isolate the documentation DocumentMapper documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
Right now it is in the IndexConfig page.
As a result, the different field type are h4.
They do not appear in the table of content on the right of the page, and they are not well spaced at all.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the IndexConfig documentation page and locate the DocumentMapper and field-type sections. Move the DocumentMapper documentation into its own section or page, ensuring field types appear in the right-hand table of contents and have consistent spacing. Done means the content is isolated, navigable, and readable.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100