feat: add disclaimer

[RishabhS7]

Add disclaimer in the "Configuration File" section

Jira Ticket 1
Jira Ticket 2

Summary by CodeRabbit

• Documentation
  • Added a deprecation disclaimer to the configuration file reference, warning that configuration files are deprecated and should only be used for demos or testing—especially when handling private keys.
  • No functional changes were introduced.
  • Applies to the v4.x documentation.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Added prominent DISCLAIMER/discouragement blocks across multiple docs clarifying the TradeTrust CLI and config files are intended only for prototyping/testing (not production) and warn about private-key risks. No code, API, or functional changes were made.

Changes

Cohort / File(s)	Change Summary
Config file deprecation versioned_docs/version-4.x/reference/document-creator/config-file.md	Inserted a top-level DISCLAIMER stating configuration files are deprecated for production use and should only be used for demo/testing, especially when private keys are involved. No functional changes.
TradeTrust CLI disclaimers (general docs) docs/how-tos/deployment.md, docs/how-tos/open-attestation/prerequisites.md, docs/how-tos/transactions.md, docs/migration-guide/migration-tt-cli-v5.md	Added prominent warning blocks advising the TradeTrust CLI is for prototyping/testing and not suitable for production due to lack of security, scalability, and operational controls. Text-only changes.
Versioned/tutorial CLI disclaimers versioned_docs/version-4.x/tutorial/prerequisites.md, versioned_docs/version-4.x/topics/verifying-documents/document-integrity.md, versioned_docs/version-4.x/tutorial/transferable-records/token-registry/token-registry-cli.mdx, versioned_docs/version-4.x/tutorial/verifiable-documents/advanced/document-store/.../document-store-cli.mdx	Inserted CLI disclaimer blocks at CLI installation/deployment sections (appearing in some files multiple times). Documentation-only edits; no logic or examples changed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

• Isaac-kps

Poem

🐇 I hopped through pages, left a careful note,
"CLI for testing" — a tiny, earnest quote.
Keep keys tucked snug, don't launch to the wild,
For demos and trials, I'm a helpful little child. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'feat: add disclaimer' is vague and does not specify which disclaimers or which parts of the documentation are being updated, despite the changeset modifying 9 files across multiple sections.	Consider a more specific title like 'feat: add TradeTrust CLI production usage disclaimers' or 'feat: add CLI and config deprecation warnings' to better reflect the scope of changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
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
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/add-disclaimer

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 537504b and 66f39f4.

📒 Files selected for processing (8)

• docs/how-tos/deployment.md
• docs/how-tos/open-attestation/prerequisites.md
• docs/how-tos/transactions.md
• docs/migration-guide/migration-tt-cli-v5.md
• versioned_docs/version-4.x/topics/verifying-documents/document-integrity.md
• versioned_docs/version-4.x/tutorial/prerequisites.md
• versioned_docs/version-4.x/tutorial/transferable-records/token-registry/token-registry-cli.mdx
• versioned_docs/version-4.x/tutorial/verifiable-documents/advanced/document-store/deploying-document-store/document-store-cli.mdx

✅ Files skipped from review due to trivial changes (4)

• versioned_docs/version-4.x/tutorial/transferable-records/token-registry/token-registry-cli.mdx
• docs/how-tos/transactions.md
• versioned_docs/version-4.x/topics/verifying-documents/document-integrity.md
• docs/migration-guide/migration-tt-cli-v5.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: Redirect rules - tradetrust-docs
• GitHub Check: Header rules - tradetrust-docs
• GitHub Check: Pages changed - tradetrust-docs

🔇 Additional comments (4)

docs/how-tos/open-attestation/prerequisites.md (1)

22-27: LGTM! Important safety warning added.

The disclaimer appropriately warns developers that the TradeTrust CLI is intended for prototyping and testing, not production use. The placement before installation instructions ensures users see this warning early.

versioned_docs/version-4.x/tutorial/prerequisites.md (1)

23-28: LGTM! Consistent safety warning.

The disclaimer is consistent with other documentation files and appropriately warns users about the limitations of the TradeTrust CLI for production environments.

docs/how-tos/deployment.md (1)

24-29: LGTM! Well-placed disclaimer.

The warning is appropriately positioned before the installation section and clearly communicates the intended use case (prototyping/testing) and production limitations.

versioned_docs/version-4.x/tutorial/verifiable-documents/advanced/document-store/deploying-document-store/document-store-cli.mdx (1)

25-30: LGTM! Appropriate disclaimer for deployment section.

The disclaimer is well-positioned before deployment instructions and maintains consistency with the warnings added throughout the documentation. This helps ensure users understand the CLI's intended scope before using it for document store deployment.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

versioned_docs/version-4.x/reference/document-creator/config-file.md (1)

15-15: Make link text more descriptive.

The link text "here" is vague. Consider using more descriptive text to improve accessibility and clarity.

🔎 Proposed improvement

-A reference of a configuration file can be found [here](https://github.com/TradeTrust/tradetrust-config/blob/master/build/sepolia/config-v2.json).
+A reference of a configuration file can be found in the [TradeTrust config repository](https://github.com/TradeTrust/tradetrust-config/blob/master/build/sepolia/config-v2.json).

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2f8359b and bac8192.

📒 Files selected for processing (1)

• versioned_docs/version-4.x/reference/document-creator/config-file.md

🧰 Additional context used

🪛 LanguageTool

versioned_docs/version-4.x/reference/document-creator/config-file.md

[style] ~11-~11: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...on files containing private keys should only be used for demo or testing purposes on...

(ONLY_EXCLUSIVELY_STYLE)

🪛 markdownlint-cli2 (0.18.1)

versioned_docs/version-4.x/reference/document-creator/config-file.md

15-15: Link text should be descriptive

(MD059, descriptive-link-text)

🔇 Additional comments (1)

versioned_docs/version-4.x/reference/document-creator/config-file.md (1)

9-11: Disclaimer content is appropriate.

The deprecation warning is clear and directly addresses the security concern about private keys in configuration files, which aligns well with the PR objective.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Remove redundant "only" usage.

The phrase "should only be used for demo or testing purposes only" contains redundant use of "only". Remove one instance for clarity.

🔎 Proposed fix

-> Configuration files have been deprecated and are not recommended for production use. Configuration files containing private keys should only be used for demo or testing purposes only.
+> Configuration files have been deprecated and are not recommended for production use. Configuration files containing private keys should only be used for demo or testing purposes.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	> Configuration files have been deprecated and are not recommended for production use. Configuration files containing private keys should only be used for demo or testing purposes only.
	> Configuration files have been deprecated and are not recommended for production use. Configuration files containing private keys should only be used for demo or testing purposes.

🧰 Tools

🪛 LanguageTool

[style] ~11-~11: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...on files containing private keys should only be used for demo or testing purposes on...

(ONLY_EXCLUSIVELY_STYLE)

🤖 Prompt for AI Agents

In versioned_docs/version-4.x/reference/document-creator/config-file.md around
line 11, the sentence contains a redundant "only" ("should only be used for demo
or testing purposes only"); remove one of the "only" words so the sentence reads
correctly (e.g., "should be used for demo or testing purposes only" or "should
only be used for demo or testing purposes").