Skip to content

Improve README formatting and structure#55

Open
Dippp10-ally wants to merge 1 commit into
optiqor:mainfrom
Dippp10-ally:patch-1
Open

Improve README formatting and structure#55
Dippp10-ally wants to merge 1 commit into
optiqor:mainfrom
Dippp10-ally:patch-1

Conversation

@Dippp10-ally

Copy link
Copy Markdown

What

Enhanced the README by improving its overall structure, formatting, and readability. Added suggestions for clearer section organization, improved navigation, and better contributor-facing documentation to make onboarding and project understanding easier.

Why

Fixes #54

The current README can be difficult to navigate due to limited structure and inconsistent formatting. Improving documentation organization helps new users quickly understand the project, follow setup instructions, and contribute more effectively.

How

  • Reorganized content into clearly defined sections.
  • Improved heading hierarchy and markdown formatting.
  • Added recommendations for installation, usage, and contribution sections.
  • Enhanced readability with lists, code blocks, and better spacing.
  • Suggested additional sections such as FAQ, troubleshooting, and project overview.

Testing

  • Documentation changes reviewed for clarity and consistency
  • Markdown formatting validated locally
  • make lint test passes locally
  • go test -race ./... passes
  • If a new rule: added a chart fixture in testdata/ and a golden output
  • Tested locally with:

Checklist

  • PR title follows Conventional Commits (docs(readme): improve formatting and structure)
  • All commits are DCO-signed (git commit -s)
  • No unrelated changes pulled in
  • Documentation updated where user-visible behavior changed
  • No LLM calls or telemetry introduced
  • No proprietary backend imports

Enhance README with formatting improvements and structure suggestions.
@Dippp10-ally Dippp10-ally requested a review from btwshivam as a code owner June 13, 2026 15:18
@github-actions github-actions Bot added documentation Improvements or additions to documentation size/S 11–50 lines labels Jun 13, 2026
@Dippp10-ally

Copy link
Copy Markdown
Author

@btwshivam ji , do assign labels called as gssoc:approved , level:intermediate , type:docs , quality:exceptional to above pull request number 55 also.....do merge above pull request number 55 also....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/S 11–50 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Improve Readme Formatting and Structure

1 participant