Skip to content

[Sistent] docs: remove hardcoded version numbers from installation page - #7883

Open
debkarma wants to merge 2 commits into
layer5io:masterfrom
debkarma:fix/sistent-versions
Open

[Sistent] docs: remove hardcoded version numbers from installation page#7883
debkarma wants to merge 2 commits into
layer5io:masterfrom
debkarma:fix/sistent-versions

Conversation

@debkarma

@debkarma debkarma commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Description

This PR fixes #7882. It removes the hardcoded React and Node.js version requirements from the Sistent Installation page. Contributors are now directed to the canonical package.json file to check for current version requirements, preventing the documentation from becoming outdated.
image

Notes for Reviewers

  • Removed the bulleted list of specific framework versions.
  • Removed the prerequisites code snippet block.
  • Added a direct link to the package.json file in the text.
  • Verified changes locally by building the dev server and confirming the UI renders correctly.

Signed commits

  • Yes, I signed my commits.

Summary by CodeRabbit

  • Documentation
    • Updated the Installation page to direct readers to the canonical package.json for current requirements.
    • Removed the outdated embedded prerequisites snippet and explicit React/React DOM version listings from the Overview section.
    • Kept a brief reminder about Node.js >=16.x.

Signed-off-by: Debajyoti Karmakar <debkarma97@gmail.com>
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 7f8350b1-594f-421e-9a9f-7dd5ae164dc9

📥 Commits

Reviewing files that changed from the base of the PR and between e4ca468 and 478797e.

📒 Files selected for processing (1)
  • src/sections/Projects/Sistent/getting-started/installation/index.js
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/sections/Projects/Sistent/getting-started/installation/index.js

📝 Walkthrough

Walkthrough

The Sistent installation page removes the embedded prerequisites version list and updates its Overview text to direct readers to the canonical package.json for current requirements.

Changes

Sistent installation documentation

Layer / File(s) Summary
Canonical requirements reference
src/sections/Projects/Sistent/getting-started/installation/index.js
The prerequisites code example is removed, and the Overview section now points readers to package.json instead of listing explicit dependency versions.

Estimated code review effort: 2 (Simple) | ~5 minutes

🚥 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 is concise and accurately summarizes the main docs change.
Linked Issues check ✅ Passed The page now points to package.json and removes the hardcoded React/peer requirement list, matching #7882.
Out of Scope Changes check ✅ Passed The changes stay within the Sistent installation docs and do not introduce unrelated edits.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/sections/Projects/Sistent/getting-started/installation/index.js

Parsing error: The keyword 'import' is reserved


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

Comment thread src/sections/Projects/Sistent/getting-started/installation/index.js
Signed-off-by: Debajyoti Karmakar <debkarma97@gmail.com>

@Maanvi212006 Maanvi212006 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, Node.js requirement is back and covered now, and confirmed the removed prerequisites code block wasn't referenced anywhere else. Approving.

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.

[Sistent] Version numbers are outdated

2 participants