Skip to content

docs: reorder README sections to improve narrative flow#157

Merged
Reefact merged 1 commit into
mainfrom
claude/readme-section-reorder-0b6nxk
Jul 16, 2026
Merged

docs: reorder README sections to improve narrative flow#157
Reefact merged 1 commit into
mainfrom
claude/readme-section-reorder-0b6nxk

Conversation

@Reefact

@Reefact Reefact commented Jul 16, 2026

Copy link
Copy Markdown
Owner

Summary

Reorganize the README sections in both English and French documentation to improve the narrative flow. The "One model for the whole chain" section is moved after "The problem" section, creating a more logical progression from problem statement to solution approach.

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • Refactoring
  • Analyzer / diagnostic change
  • Tests
  • Documentation
  • Build / CI / tooling

Changes

  • Moved "🧩 One model for the whole chain" section in README.md to appear after "🚨 The problem" section
  • Moved "🧩 Un seul modèle pour toute la chaîne" section in doc/README.fr.md to appear after "🚨 Le problème" section
  • No content changes; sections are reordered to improve readability and narrative structure

Documentation

  • Public API / error documentation updated
  • README / doc/ updated
  • French translation (doc/README.fr.md) updated if user-facing behavior changed
  • No documentation change required

Architecture decisions

  • No architectural decision in this pull request

Related issues

https://claude.ai/code/session_01R79xDspf96YW7bLnWsrgph

Swap the "The problem" and "One model for the whole chain" sections so
the README follows a problem-then-solution narrative, and trim the now
redundant opening sentence of the model overview. Applied to both the
English README and the French translation to keep them in sync.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01R79xDspf96YW7bLnWsrgph
@Reefact
Reefact enabled auto-merge July 16, 2026 06:44
@Reefact
Reefact merged commit e4fd8e7 into main Jul 16, 2026
12 checks passed
@Reefact
Reefact deleted the claude/readme-section-reorder-0b6nxk branch July 16, 2026 06:45
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.

2 participants