Skip to content

Adjust diagrams to use same wording#1271

Merged
fizyk merged 2 commits intomainfrom
update-diagrams
Feb 4, 2026
Merged

Adjust diagrams to use same wording#1271
fizyk merged 2 commits intomainfrom
update-diagrams

Conversation

@fizyk
Copy link
Member

@fizyk fizyk commented Feb 4, 2026

Chore that needs to be done:

  • Add newsfragment pipenv run towncrier create [issue_number].[type].rst

Types are defined in the pyproject.toml, issue_number either from issue tracker or the Pull request number

Summary by CodeRabbit

Documentation

  • Improved architecture diagrams with standardised naming conventions and unified terminology for enhanced clarity across documentation.
  • Refined diagram sequences and participant definitions to better represent current architectural concepts and relationships.
  • Standardised documentation language to ensure consistent understanding of system architecture.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 4, 2026

📝 Walkthrough

Walkthrough

These are documentation-only changes that standardise terminology across architecture diagrams. The Mermaid sequence diagrams are updated to replace Test/Fixture-oriented naming with Pytest-centric terminology (e.g., ProcFactory → base_proc fixture, PgServer → PostgreSQL server), ensuring consistent nomenclature across documentation.

Changes

Cohort / File(s) Summary
Architecture Diagrams
docs/architecture.mmd, docs/architecture_chaining.mmd
Updated Mermaid sequence diagrams to use unified terminology: renamed participants from ProcFactory/PostgreSQL process to BaseProc/base_proc fixture and PostgreSQL server; refreshed message labels and flow descriptions to reflect Pytest-centric naming conventions.
Release Notes
newsfragments/+56cec843.docs.rst
Added changelog fragment documenting the diagrams terminology unification.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 ✨ The diagrams now speak with a single voice,
No more confusion from naming's old noise,
BaseProc and Pytest, unified and bright,
Our architecture shines with consistent light! 🎯

🚥 Pre-merge checks | ✅ 3 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Newsfragment Check ⚠️ Warning Newsfragment file uses hash-based identifier instead of PR number in filename. Rename newsfragments/+56cec843.docs.rst to newsfragments/1271.docs.rst or regenerate using pipenv run towncrier create 1271.docs.rst.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Adjust diagrams to use same wording' directly and clearly summarises the main change: updating diagram terminology for consistency across multiple diagram files (architecture.mmd and architecture_chaining.mmd).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-diagrams

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@fizyk fizyk merged commit 92c3665 into main Feb 4, 2026
2 checks passed
@fizyk fizyk deleted the update-diagrams branch February 4, 2026 10:08
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.

1 participant