Skip to content

docs: rename ubiquitous language glossary to CONTEXT and add message state vocabulary#7450

Closed
diegolmello wants to merge 1 commit into
developfrom
docs/native-1345-context-rename
Closed

docs: rename ubiquitous language glossary to CONTEXT and add message state vocabulary#7450
diegolmello wants to merge 1 commit into
developfrom
docs/native-1345-context-rename

Conversation

@diegolmello

@diegolmello diegolmello commented Jun 26, 2026

Copy link
Copy Markdown
Member

Proposed changes

Rename the ubiquitous-language glossary UBIQUITOUS_LANGUAGE.md to CONTEXT.md (git history preserved) and update its three references across the codebase.

Adds a Message Interaction & Position State section that records the shared domain vocabulary for two kinds of transient message state, since they are owned by different parts of the app and migrated independently:

  • Interaction state — the current selection plus the reply/quote/edit/react action; owned by the per-Room interaction store.
  • Positional state — the highlighted message plus jump/scroll position; owned by the Room view scroll machinery.

Issue(s)

https://rocketchat.atlassian.net/browse/NATIVE-1345

How to test or reproduce

Documentation only — no runtime behaviour changes. To verify:

  • CONTEXT.md exists at the repo root and contains the Message Interaction & Position State section.
  • UBIQUITOUS_LANGUAGE.md no longer exists.
  • The three references resolve to the new filename:
    • CLAUDE.md
    • app/lib/services/voip/docs/README.md
    • app/views/RoomView/docs/ARCHITECTURE.md

Screenshots

N/A — documentation only.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • Improvement (non-breaking change which improves a current function)
  • New feature (non-breaking change which adds functionality)
  • Documentation update (if none of the other choices apply)

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • I have added necessary documentation (if applicable)
  • Any dependent changes have been merged and published in downstream modules

Further comments

The glossary rename is done with git mv so blame/history follow the file (detected as a 94%-similarity rename). This PR is documentation-only and intentionally carries no code changes, so it can merge independently of the related model work.

Summary by CodeRabbit

  • Documentation
    • Updated repository guidance and cross-references to use the new shared context glossary.
    • Added clearer definitions for two separate transient message-related states, including where each lives and how each is handled.
    • Aligned room and VoIP documentation with the updated glossary location.

…state vocabulary

Rename UBIQUITOUS_LANGUAGE.md to CONTEXT.md (history preserved) and update its
three references in CLAUDE.md, the VoIP docs README, and the RoomView
architecture doc. Add the "Message Interaction & Position State" section
distinguishing Interaction state (selection plus the reply/quote/edit/react
action, owned by the per-Room interaction store) from Positional state
(highlight plus jump/scroll position, owned by the Room view scroll machinery),
since the two are migrated independently.

Ref: NATIVE-1345

Claude-Session: https://claude.ai/code/session_01Cj1jHhEbiC9mWGe8dpqQeS
@diegolmello diegolmello requested a deployment to approve_e2e_testing June 26, 2026 21:12 — with GitHub Actions Waiting
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 20b4dc72-2a03-400c-aa5b-fbec56c5530c

📥 Commits

Reviewing files that changed from the base of the PR and between a8c4899 and a03dc92.

📒 Files selected for processing (4)
  • CLAUDE.md
  • CONTEXT.md
  • app/lib/services/voip/docs/README.md
  • app/views/RoomView/docs/ARCHITECTURE.md
📜 Recent review details
⏰ Context from checks skipped due to timeout. (1)
  • GitHub Check: ESLint and Test / run-eslint-and-test
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: RocketChat/Rocket.Chat.ReactNative

Timestamp: 2026-06-26T21:13:29.502Z
Learning: Before committing, run `pnpm prettier-lint` and `TZ=UTC pnpm test` for the modified files.
Learnt from: CR
Repo: RocketChat/Rocket.Chat.ReactNative

Timestamp: 2026-06-26T21:13:29.502Z
Learning: Pre-commit hooks are expected to enforce the repository's formatting and testing checks.
🔇 Additional comments (4)
CONTEXT.md (1)

55-63: LGTM!

CLAUDE.md (1)

12-12: LGTM!

app/lib/services/voip/docs/README.md (1)

15-15: LGTM!

app/views/RoomView/docs/ARCHITECTURE.md (1)

3-3: LGTM!


Walkthrough

Docs now reference CONTEXT.md instead of UBIQUITOUS_LANGUAGE.md in project guidance, VoIP and RoomView docs, and CONTEXT.md now includes a Room section defining interaction and position state.

Changes

Context glossary and references

Layer / File(s) Summary
Room state glossary
CONTEXT.md
Adds a markdown section defining interaction state and position state for Room views, including ownership and migration behavior.
Reference redirects
CLAUDE.md, app/lib/services/voip/docs/README.md, app/views/RoomView/docs/ARCHITECTURE.md
Updates project guidance and related docs to link to CONTEXT.md instead of UBIQUITOUS_LANGUAGE.md.

Estimated review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

type: chore

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the glossary rename and the added message state vocabulary.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • NATIVE-1345: Request failed with status code 401

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.

@diegolmello

Copy link
Copy Markdown
Member Author

Closing in favor of #7455, which carries these commits as part of the NATIVE-22 message-hooks work.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant