Skip to content

TTYG-178 Improve documentation#51

Merged
pgan002 merged 177 commits into
mainfrom
TTYG-178
Jun 19, 2026
Merged

TTYG-178 Improve documentation#51
pgan002 merged 177 commits into
mainfrom
TTYG-178

Conversation

@pgan002

@pgan002 pgan002 commented Feb 7, 2026

Copy link
Copy Markdown
Collaborator

Changes

  • Move most of the documentation from the README file into separate files in a new directory docs/. Benefits:
    1. The main page (README) is shorter, and so more welcoming
    2. The main page loads faster
    3. The sections are shorter and so easier to read
    4. The directory helps to understand the contents
  • Major additions for completeness
  • Major edits clarity
  • Links to documentation sections from README and from other sections
  • Consistent section heading case: sentence case
  • Join each paragraph into a single line for easier MD editing

Tests

  • Spelling, grammar, typos: copy-pasted text into word processor
  • Links: manually followed each link in README.md and docs/*

Open questions

  • How to format the key-definitions in § Output: as a list or table?
  • Move section "Aggregate metrics" to a separate file or into section Metrics?

@pgan002 pgan002 closed this Mar 14, 2026
@pgan002 pgan002 reopened this Mar 14, 2026
@pgan002 pgan002 requested review from atagarev and nelly-hateva and removed request for atagarev and nelly-hateva March 14, 2026 02:51
@pgan002 pgan002 self-assigned this Mar 14, 2026
Comment thread README.md
Comment thread docs/usage.md Outdated
Comment thread docs/installation.md Outdated
Comment thread docs/install.md Outdated
Comment thread docs/steps-score.md Outdated
Comment thread docs/steps-score.md Outdated
Comment thread docs/steps-score.md Outdated
Comment thread docs/steps-score.md Outdated
Comment thread docs/retrieval-evaluation-using-chunk-ids.md Outdated
Comment thread docs/0-intro.md Outdated
Comment thread docs/0-intro.md Outdated
@pgan002 pgan002 requested a review from nelly-hateva March 30, 2026 08:09
Comment thread README.md Outdated
Comment thread docs/installation.md Outdated
Comment thread docs/usage.md Outdated
Comment thread docs/usage.md Outdated
Comment thread docs/usage.md Outdated
Comment thread docs/usage.md Outdated
Comment thread docs/config.md Outdated
@pgan002 pgan002 changed the title TTYG-178 Improve README TTYG-178 Improve documentation Jun 19, 2026
@pgan002 pgan002 merged commit 7576e80 into main Jun 19, 2026
2 checks passed
@nelly-hateva nelly-hateva deleted the TTYG-178 branch June 19, 2026 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants