Skip to content

docs: create reports archive directory#2159

Closed
shady-2004 wants to merge 4 commits into
hiero-ledger:mainfrom
shady-2004:docs/add-reports-archive
Closed

docs: create reports archive directory#2159
shady-2004 wants to merge 4 commits into
hiero-ledger:mainfrom
shady-2004:docs/add-reports-archive

Conversation

@shady-2004

Copy link
Copy Markdown
Contributor

Description:
This PR adds a dedicated directory for publicly available report archives to satisfy project compliance and transparency requirements.

  • Create the docs/reports directory
  • Add a README.md file explaining the purpose of the archive for later searching

Related issue(s):

Fixes #2144

Notes for reviewer:
This is a documentation-only change to satisfy the project's requirement for a publicly available report archive. No code logic or SDK functionality was modified.

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

Signed-off-by: shady-2004 <shadyshiko2004@gmail.com>
@codacy-production

codacy-production Bot commented Apr 16, 2026

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

@coderabbitai

coderabbitai Bot commented Apr 16, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

Added a new documentation file docs/reports/README.md describing a publicly available archive for reports and responses. Updated .env.example to replace placeholder values for OPERATOR_ID, OPERATOR_KEY, and NETWORK with concrete example values (testnet and specific example ID/key).

Changes

Cohort / File(s) Summary
Documentation
docs/reports/README.md
New file added with a single-line description that the folder provides a publicly available archive for reports and responses for later searching.
Configuration / Env examples
.env.example
Replaced placeholder environment variable examples: OPERATOR_ID, OPERATOR_KEY now set to concrete example strings; NETWORK set to testnet instead of a generic placeholder.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning Changes to .env.example with concrete credentials appear unrelated to the stated objective of creating a reports documentation directory. Remove .env.example changes and verify the credentials were not intended for this PR. Revert to placeholder values or explain their necessity.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: create reports archive directory' accurately describes the main change—adding documentation for a reports archive directory.
Description check ✅ Passed The description clearly relates to the changeset, explaining the purpose of the documentation changes and referencing the linked issue.
Linked Issues check ✅ Passed The PR creates docs/reports with README.md explaining the archive purpose, directly satisfying issue #2144 requirements for a publicly available reports archive.
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

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.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: d9f25a52-ccb1-4975-9893-5fcddc1f3699

📥 Commits

Reviewing files that changed from the base of the PR and between 93a8f44 and e81a3cd.

📒 Files selected for processing (1)
  • docs/reports/README.md

Comment thread docs/reports/README.md Outdated

Copilot AI 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.

Pull request overview

Adds a new documentation location intended to serve as a publicly accessible archive for reports/responses, addressing the compliance/transparency requirement from #2144.

Changes:

  • Create a new docs/reports/ directory for report archives
  • Add docs/reports/README.md describing the purpose of the archive

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/reports/README.md Outdated
Comment thread docs/reports/README.md Outdated
Signed-off-by: shady-2004 <shadyshiko2004@gmail.com>
exploreriii
exploreriii previously approved these changes Apr 16, 2026

@exploreriii exploreriii 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.

Perfect! Thank you so much

@exploreriii exploreriii added step: 2nd second stage of the review approval process reviewer: write requires a review with write permissions labels Apr 16, 2026
manishdait
manishdait previously approved these changes Apr 17, 2026
@github-actions github-actions Bot added Good First Issue Issues which are ideal for a first time or new project contributor. scope: docs involves documentation labels Apr 17, 2026
@manishdait

Copy link
Copy Markdown
Contributor

Hi @shady-2004, the pre-commit checks are failing, Please add the Pre-Commit Setup and then push the changes

@shady-2004
shady-2004 dismissed stale reviews from manishdait and exploreriii via 301aa62 April 17, 2026 11:32
@shady-2004 shady-2004 closed this Apr 17, 2026
@shady-2004
shady-2004 deleted the docs/add-reports-archive branch April 17, 2026 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Good First Issue Issues which are ideal for a first time or new project contributor. reviewer: write requires a review with write permissions scope: docs involves documentation step: 2nd second stage of the review approval process

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create docs/reports

4 participants