Skip to content

feat: remove docs directory - #1746

Merged
ericnordelo merged 1 commit into
mainfrom
feat/remove-docs-directory
Aug 19, 2026
Merged

feat: remove docs directory#1746
ericnordelo merged 1 commit into
mainfrom
feat/remove-docs-directory

Conversation

@ericnordelo

@ericnordelo ericnordelo commented Aug 18, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation

    • Removed the in-repository documentation site and API reference pages.
    • Removed guides covering installation, interfaces, presets, upgrades, security, tokens, accounts, finance, and the Cairo Wizard.
    • Updated contribution guidance to direct documentation updates to the external documentation repository.
  • Release Process

    • Simplified release preparation to track the package version.
    • Added tooling to generate and validate preset class hashes for release artifacts.

@ericnordelo
ericnordelo requested review from bidzyyys and immrsd August 18, 2026 14:23
@coderabbitai

coderabbitai Bot commented Aug 18, 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: f343ff5a-5819-487f-9e57-690e3681693f

📥 Commits

Reviewing files that changed from the base of the PR and between ce61bb3 and 45fc121.

📒 Files selected for processing (29)
  • .github/workflows/prepare-release.yml
  • .gitignore
  • CONTRIBUTING.md
  • docs/antora.yml
  • docs/modules/ROOT/pages/api/access.adoc
  • docs/modules/ROOT/pages/api/account.adoc
  • docs/modules/ROOT/pages/api/erc1155.adoc
  • docs/modules/ROOT/pages/api/erc20.adoc
  • docs/modules/ROOT/pages/api/erc6909.adoc
  • docs/modules/ROOT/pages/api/erc721.adoc
  • docs/modules/ROOT/pages/api/finance.adoc
  • docs/modules/ROOT/pages/api/governance.adoc
  • docs/modules/ROOT/pages/api/introspection.adoc
  • docs/modules/ROOT/pages/api/merkle-tree.adoc
  • docs/modules/ROOT/pages/api/security.adoc
  • docs/modules/ROOT/pages/api/token_common.adoc
  • docs/modules/ROOT/pages/api/udc.adoc
  • docs/modules/ROOT/pages/api/upgrades.adoc
  • docs/modules/ROOT/pages/backwards-compatibility.adoc
  • docs/modules/ROOT/pages/erc4626.adoc
  • docs/modules/ROOT/pages/index.adoc
  • docs/modules/ROOT/pages/interfaces.adoc
  • docs/modules/ROOT/pages/macros.adoc
  • docs/modules/ROOT/pages/presets.adoc
  • docs/modules/ROOT/pages/upgrades.adoc
  • docs/modules/ROOT/pages/utils/_class_hashes.adoc
  • docs/modules/ROOT/pages/wizard.adoc
  • scripts/generate_class_hashes.py
  • scripts/get_hashes_page.py
💤 Files with no reviewable changes (25)
  • docs/antora.yml
  • docs/modules/ROOT/pages/macros.adoc
  • docs/modules/ROOT/pages/backwards-compatibility.adoc
  • docs/modules/ROOT/pages/index.adoc
  • scripts/get_hashes_page.py
  • docs/modules/ROOT/pages/interfaces.adoc
  • docs/modules/ROOT/pages/api/finance.adoc
  • docs/modules/ROOT/pages/api/account.adoc
  • docs/modules/ROOT/pages/api/erc20.adoc
  • docs/modules/ROOT/pages/api/upgrades.adoc
  • docs/modules/ROOT/pages/api/access.adoc
  • docs/modules/ROOT/pages/api/erc1155.adoc
  • .gitignore
  • docs/modules/ROOT/pages/api/introspection.adoc
  • docs/modules/ROOT/pages/api/erc6909.adoc
  • docs/modules/ROOT/pages/utils/_class_hashes.adoc
  • docs/modules/ROOT/pages/wizard.adoc
  • docs/modules/ROOT/pages/api/token_common.adoc
  • docs/modules/ROOT/pages/erc4626.adoc
  • docs/modules/ROOT/pages/api/merkle-tree.adoc
  • docs/modules/ROOT/pages/api/udc.adoc
  • docs/modules/ROOT/pages/api/erc721.adoc
  • docs/modules/ROOT/pages/presets.adoc
  • docs/modules/ROOT/pages/api/security.adoc
  • docs/modules/ROOT/pages/upgrades.adoc

Included review availability: 4 reviews are currently available. Based on recent review activity, included reviews refill at 5 per hour.


Walkthrough

The pull request adds a class-hash generation CLI, updates contribution guidance for external documentation, removes local documentation pages and build settings, and simplifies release automation.

Changes

Documentation workflow transition

Layer / File(s) Summary
Class-hash generation CLI
scripts/generate_class_hashes.py
Adds a CLI that builds or reads preset artifacts, validates manifests and hashes, computes Sierra class hashes with starkli, and outputs ordered JavaScript constants.
Contributor workflow instructions
CONTRIBUTING.md
Directs contributors to update the external documentation repository and documents class-hash generation commands, including --no-build.
Local documentation and release cleanup
.github/workflows/prepare-release.yml, .gitignore, docs/antora.yml, docs/modules/ROOT/pages/*
Removes local documentation pages and build configuration. Simplifies release version extraction, removes preset build steps, and removes documentation build ignore rules.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to 45fc1

This PR removes the in-repository documentation and updates related project plumbing; no actionable correctness or merge-blocking risk remains in the supplied evidence, so it is merge-ready after normal checks and review.

Sequence Diagram(s)

sequenceDiagram
  participant Contributor
  participant CLI as generate_class_hashes.py
  participant Scarb
  participant Starkli
  Contributor->>CLI: run class-hash generation
  CLI->>Scarb: build or read preset artifacts
  CLI->>CLI: validate artifact manifest
  CLI->>Starkli: compute Sierra class hashes
  Starkli-->>CLI: return validated hashes
  CLI-->>Contributor: output JavaScript constants
Loading

Poem

I hop through hashes, neat and bright,
With presets sorted just right.
Docs take flight to a distant place,
Release steps shrink with rabbit grace.
Squeak—clean builds now win the race!

🚥 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 clearly and concisely identifies the primary change: removing the documentation directory.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/remove-docs-directory

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

@codecov

codecov Bot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@bidzyyys bidzyyys left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@bidzyyys bidzyyys linked an issue Aug 18, 2026 that may be closed by this pull request

@immrsd immrsd left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@ericnordelo
ericnordelo merged commit d7c0466 into main Aug 19, 2026
16 checks passed
@ericnordelo
ericnordelo deleted the feat/remove-docs-directory branch August 19, 2026 11:37
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.

Remove in-repo docs (centralize in OpenZeppelin/docs)

3 participants