Repository navigation
docs: fix stale paths and links in DEVELOPMENT.md - #2999
Open
imitater-dou wants to merge 1 commit into
Open
imitater-dou wants to merge 1 commit into
imitater-dou wants to merge 1 commit into
Conversation
- The `core/` directory no longer exists; the core machine crate and its tests (including the `debug` feature example below) live in `crates/core/machine`. - The mdbook sources were removed from this repo in succinctlabs#2105, so `mdbook serve` no longer works here; point to the published docs. - `.github/workflows/release-plz.yml` was removed in succinctlabs#2576; drop the dead link. Signed-off-by: ADou <ikun3.1415927@gmail.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
A few instructions in
DEVELOPMENT.mdno longer match the repository layout onmain, so following them fails:cd core && cargo test, but there is no top-levelcore/directory anymore (the core crates were moved undercrates/core/). The--features debugexample further down (syscall::precompiles::edwards::ed_add::tests::test_ed_add_simple) belongs tosp1-core-machineincrates/core/machine, which is also where thedebugfeature is defined.mdbook servein the top-level directory, but the book was removed in chore(docs): remove book #2105 (docs migrated elsewhere), and there is nobook.tomlanywhere in the tree..github/workflows/release-plz.yml, which was removed in fix: Remove release-plz workflow, and fix some issues in release.yml #2576.Repro on
main(9e94952):Solution
cd core->cd crates/core/machine.release-plz.ymllink and keep therelease-plz.tomlreference, which still exists. I left the rest of the Publishing section unchanged since the release flow is maintainer-owned.PR Checklist