docs: remove archived cactus docs and fix broken references#4473
docs: remove archived cactus docs and fix broken references#4473ParthSinghPS wants to merge 1 commit into
Conversation
Remove the deprecated docs/docs/cactus/ directory and resolve all references to it across the repository before deletion, as advised by maintainer feedback on PR hyperledger-cacti#4467. Changes made: - Delete docs/docs/cactus/ folder (archived legacy content) - Remove Cactus nav section from docs/mkdocs.yml (41 entries) - Remove broken SATP Hermes nav entry from docs/mkdocs.yml - Migrate ledger-browser/setup.md to packages/cacti-ledger-browser/docs/ - Migrate build-script-decision-tree PNG and watch-script GIF to images/ - Fix image paths in BUILD.md and README-cactus.md - Update app doc/setup URLs in cacti-ledger-browser eth and fabric apps - Fix cactus/introduction links in README.md and CONTRIBUTING.md - Update docs/docs/index.md, guides/developers.md, getting-started.md Assisted-by: claude-opus 4.8 Signed-off-by: ParthSinghPS <posiedon.1721@gmail.com>
| We welcome contributions to this project in many forms, whether it is to fix a bug, improve the documentation, add a new feature, or add support for any new DLT platform. | ||
|
|
||
| Please familiarize yourself with the [documentation](https://hyperledger-cacti.github.io/cacti/). In particular, review the [vision and design methodology](https://hyperledger-cacti.github.io/cacti/vision/) and [system architecture](https://hyperledger-cacti.github.io/cacti/architecture/). Follow the tutorial instructions to test the [Cactus](https://hyperledger-cacti.github.io/cacti/cactus/introduction/) and [Weaver](https://hyperledger-cacti.github.io/cacti/weaver/introduction/) features respectively. (For a deeper understanding of the Weaver design and specifications, also check out the [Weaver RFCs](https://github.com/hyperledger-cacti/cacti/tree/main/weaver/rfcs).) | ||
| Please familiarize yourself with the [documentation](https://hyperledger-cacti.github.io/cacti/). In particular, review the [vision and design methodology](https://hyperledger-cacti.github.io/cacti/vision/) and [system architecture](https://hyperledger-cacti.github.io/cacti/architecture/). Follow the tutorial instructions to test the [Cactus](https://hyperledger-cacti.github.io/cacti/) and [Weaver](https://hyperledger-cacti.github.io/cacti/weaver/introduction/) features respectively. (For a deeper understanding of the Weaver design and specifications, also check out the [Weaver RFCs](https://github.com/hyperledger-cacti/cacti/tree/main/weaver/rfcs).) |
There was a problem hiding this comment.
https://hyperledger-cacti.github.io/cacti/ is the documentation home page, and as such doesn't contain specific tutorial instructions for "Cactus" the way the other link does for "Weaver".
We ought to replace the Cactus build instructions removed in this PR with something else that users can be pointed to. I'm fine with calling it "Cacti build instructions" and avoid using the "Cactus" name is that is now obsolete. But since Weaver is still a separate system from the rest of the Cacti packages, we'll need to retain a separate tab in the documentation website for Weaver.
If we don't have a substitute for the deleted instructions at this time, then suggest that we remove the Cactus reference (for now) and just have the following sentence:
Follow the tutorial instructions to test [Weaver](https://hyperledger-cacti.github.io/cacti/weaver/introduction/) features.
There was a problem hiding this comment.
With the docs changes, I think we don't need to retain this file at all. But if we delete this, we need to move some general content to the main README.md and remove references to this file wherever they exist.
| See the official [Confluence high-level project overview](https://lf-hyperledger.atlassian.net/wiki/spaces/cactus/overview?homepageId=20414469). | ||
|
|
||
| For project vision and goals, technical details, and more, see the official [Hyperledger Cacti documentation](https://hyperledger-cacti.github.io/cacti/) to get all your questions answered about the project, to get started with setup, testing, and evaluation, and to get hands-on with code and configurations. Here, you can find separate (and specific) instructions for getting started with running and experimenting with [Cactus modules](https://hyperledger-cacti.github.io/cacti/cactus/introduction/) and [Weaver modules](https://hyperledger-cacti.github.io/cacti/weaver/introduction/) respectively. | ||
| For project vision and goals, technical details, and more, see the official [Hyperledger Cacti documentation](https://hyperledger-cacti.github.io/cacti/) to get all your questions answered about the project, to get started with setup, testing, and evaluation, and to get hands-on with code and configurations. Here, you can find separate (and specific) instructions for getting started with running and experimenting with [Cactus modules](https://hyperledger-cacti.github.io/cacti/) and [Weaver modules](https://hyperledger-cacti.github.io/cacti/weaver/introduction/) respectively. |
There was a problem hiding this comment.
As I said in my other comment, it doesn't make sense to retain the "Cactus modules" part here, since the documentation site no longer provides a separate set of instructions for those.
|
@AndreAugusto11 @RafaelAPB Personally, I'd prefer we do a comprehensive update of the docs rather than make piecemeal changes, like deleting the I think we ought to review the documentation site, redesign it based on the project's present state and offerings, and add/remove content accordingly. Specifically, we should update the architecture, list up front what capabilities are offered by Cacti (perhaps categorized into Cacti, Cacti-Weaver, and Cacti-SATP). I think we should also call out SATP as a separate feature set that deserves its own set of pages. Until we do this, I think it probably makes sense to retain the Cactus section, even if the content there is stale. Otherwise, whatever we've written in markdown files outside of the "docs/cactus" folder and in other markdown files in the repo runs the risk of being incoherent or misleading users who are encountering Cacti for the first time. |
Agreed. @ParthSinghPS for now could you just focus on fixing broken references on the current PR? |
|
yeah no problem |
Remove the deprecated docs/docs/cactus/ directory and resolve all references to it across the repository before deletion, as advised by maintainer feedback on PR #4467.
Changes made:
Assisted-by: claude-opus 4.8