NVIDIA / NVIDIA/NeMo-Retriever

[DOC]: Add LLM Prompt File for Documentation Standards

Open
#1,046 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc
Dominant language
Python
Stars
3k
Forks
349
Avg merge
1d 23h
Merged PRs (30d)
116

Description

How would you describe the priority of this documentation request

Currently preventing usage

Describe the future/missing documentation

Description:
We need to create a dedicated LLM prompt file that establishes clear requirements, styling, and formatting standards for any AI-generated documentation. This will ensure consistency across all docs and reduce the amount of manual cleanup required.

Requirements:
The prompt file should outline standards for:

Grammar & Vocabulary: preferred tone, tense, and reading level.

Structure & Layout: headings, sections, and logical flow.

Tables: column alignment, header formatting, max width recommendations.

Code Examples: language identifiers, indentation, inline comments, error handling expectations.

Lists: bullet vs. numbered usage.

References/Links: citation style, internal vs external links.

General Formatting: line length, whitespace rules, bold/italics usage.

Where have you looked?

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name a target file, documentation directory, or existing standards to update. First locate the repository's documentation structure and any contributor or style guidance, then create the dedicated prompt file covering the listed grammar, layout, table, code, list, link, and formatting rules; done means the file is present and all requirements are addressed.

Written by the indexing model from the issue text.

Assessment

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.