Skip to content

[doc] Remove stale references found by a full doc audit - #216

Merged
cendhu merged 1 commit into
hyperledger:mainfrom
liran-funaro:doc-stale-meta-namespace-key
Nov 2, 2026
Merged

cendhu merged 1 commit into
hyperledger:mainfrom
liran-funaro:doc-stale-meta-namespace-key

Conversation

@liran-funaro

@liran-funaro liran-funaro commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Type of change

  • Documentation update
  • Improvement (improvement to code, performance, etc)

Description

  • Drop the MetaNamespacePolicyKey divergence from README.md, AGENTS.md, and the development and pr-review skills. No code ever had that name. The real field, MetaNamespaceVerificationKey, was removed in remove MetaNamespaceVerificationKey #74, so ARMA is the only remaining config divergence.
  • README.md: point the provenance list at tools/configtxgen (not internaltools/) and cmd/cryptogen (not the removed osnadmin).
  • AGENTS.md: add the missing common/ packages and tools/fxadmin, pkg/, fileutil/ to the structure tree.
  • sampleconfig/configtx.yaml and docs/configtx.md §7: list arma as an orderer type, mark the endpoint id as required, drop the endpoint examples without an id, and stop documenting msp-id.
  • docs/configtx.md:
    • §8.5 now documents ACLs as implemented: configtx.yaml → the /Channel/Application ACLs value → PolicyRefForAPI, including the committer's gRPC full-method keys merged in [sampleconfig] Add ACLs for the committer's exposed resources to configtx.yaml #209.
    • §11 now follows the TwoOrgsSampleFabricX profile shape (one party per org, on its own host) and lists the ACLs value under Application/Values as plain YAML.
    • LifecycleEndorsement is labelled as namespace creation and Endorsement as transaction endorsement, since Fabric-X has no chaincode.
    • Add MaxPartyID to the SharedConfig tree.
  • asn1_tx_schema.asn: rename protoblocktx.Tx to applicationpb.Tx in the header comment.
  • development skill: make mocks also covers interfaces listed in .mockery.yml.
  • Drop the agent symlinks, as [agents] Drop CLAUDE.md symlink and the unused .bob folder fabric-x-committer#873 did in the committer:
    • Remove the CLAUDE.md -> AGENTS.md symlink, since Claude Code now reads AGENTS.md directly.
    • Move the skills from .bob/skills/ to .claude/skills/. Before this change .claude/skills was a symlink pointing into .bob/.
    • Remove .bob/rules/01-project-guidelines.md, which was a symlink to AGENTS.md, and with it the rest of the unused .bob folder.
    • Update the doc-audit skill, .gitignore and scripts/license-lint.sh so nothing still points at CLAUDE.md or .bob.
  • .claude/settings.json: set attribution to empty commit and pr text and sessionUrl: false, so Claude Code adds no attribution to commits or PRs made in this repo.

Related issues

@liran-funaro liran-funaro added the documentation Improvements or additions to documentation label Oct 20, 2026
@coveralls

coveralls commented Oct 20, 2026 •

Copy link
Copy Markdown

Coverage Status

coverage: 81.291% (-0.01%) from 81.304% — liran-funaro:doc-stale-meta-namespace-key into hyperledger:main

@liran-funaro
liran-funaro force-pushed the doc-stale-meta-namespace-key branch 2 times, most recently from f133161 to 1fd7750 Compare October 21, 2026 09:17
@liran-funaro
liran-funaro requested a review from cendhu October 21, 2026 13:00
@liran-funaro
liran-funaro force-pushed the doc-stale-meta-namespace-key branch 2 times, most recently from 4dc255b to c3599ff Compare October 28, 2026 09:03
#### Type of change

- Documentation update
- Improvement (improvement to code, performance, etc)

#### Description

- Drop the `MetaNamespacePolicyKey` divergence from `README.md`, `AGENTS.md`, and the `development` and `pr-review` skills. No code ever had that name. The real field, `MetaNamespaceVerificationKey`, was removed in hyperledger#74, so `ARMA` is the only remaining config divergence.
- `README.md`: point the provenance list at `tools/configtxgen` (not `internaltools/`) and `cmd/cryptogen` (not the removed `osnadmin`).
- `AGENTS.md`: add the missing `common/` packages and `tools/fxadmin`, `pkg/`, `fileutil/` to the structure tree.
- `sampleconfig/configtx.yaml` and `docs/configtx.md` §7: list `arma` as an orderer type, mark the endpoint `id` as required, drop the endpoint examples without an `id`, and stop documenting `msp-id`.
- `docs/configtx.md`:
  - §8.5 now documents ACLs as implemented: `configtx.yaml` → the `/Channel/Application` `ACLs` value → `PolicyRefForAPI`, including the committer's gRPC full-method keys merged in hyperledger#209.
  - §11 now follows the `TwoOrgsSampleFabricX` profile shape (one party per org, on its own host) and lists the `ACLs` value under `Application/Values` as plain YAML.
  - `LifecycleEndorsement` is labelled as namespace creation and `Endorsement` as transaction endorsement, since Fabric-X has no chaincode.
  - Add `MaxPartyID` to the `SharedConfig` tree.
- `asn1_tx_schema.asn`: rename `protoblocktx.Tx` to `applicationpb.Tx` in the header comment.
- `development` skill: `make mocks` also covers interfaces listed in `.mockery.yml`.
- Drop the agent symlinks, as hyperledger/fabric-x-committer#873 did in the committer:
  - Remove the `CLAUDE.md` -> `AGENTS.md` symlink, since Claude Code now reads `AGENTS.md` directly.
  - Move the skills from `.bob/skills/` to `.claude/skills/`. Before this change `.claude/skills` was a symlink pointing into `.bob/`.
  - Remove `.bob/rules/01-project-guidelines.md`, which was a symlink to `AGENTS.md`, and with it the rest of the unused `.bob` folder.
  - Update the `doc-audit` skill, `.gitignore` and `scripts/license-lint.sh` so nothing still points at `CLAUDE.md` or `.bob`.
- `.claude/settings.json`: set `attribution` to empty `commit` and `pr` text and `sessionUrl: false`, so Claude Code adds no attribution to commits or PRs made in this repo.

#### Related issues

- follows up on hyperledger#74
- related to hyperledger#209

Signed-off-by: Liran Funaro <liran.funaro@gmail.com>
@liran-funaro
liran-funaro force-pushed the doc-stale-meta-namespace-key branch from c3599ff to 4158ad0 Compare October 29, 2026 14:46
@cendhu
cendhu merged commit e32b2d7 into hyperledger:main Nov 2, 2026
5 checks passed
@liran-funaro
liran-funaro deleted the doc-stale-meta-namespace-key branch November 2, 2026 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants