Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Cargo readme generates wrong links in Markdown #7146

Closed
TriplEight opened this issue Sep 18, 2020 · 3 comments · Fixed by #7176
Closed

Cargo readme generates wrong links in Markdown #7146

TriplEight opened this issue Sep 18, 2020 · 3 comments · Fixed by #7176
Assignees
@stiiifff
Labels
I6-documentation Documentation needs fixing, improving or augmenting. Z2-medium Can be fixed by a coder with good Rust knowledge but little knowledge of the codebase.

Comments

@TriplEight
Copy link
Contributor

Doing #7145 I've crossed @gnunicorn 's cargo-unleash, that uses cargo-readme which has a bug with creating links. It also has a suggested workaround.

Because of the docs might be outdated when the crate has changed, the idea was to have cargo-unleash run automatically for crates that changed when releasing.

This will definitely conflict with a link checker CI job unless there will be a fix.
@TriplEight TriplEight added I3-bug The node fails to follow expected behavior. C3-medium PR touches the given topic and has a medium impact on builders. labels Sep 18, 2020
@bkchr bkchr added I6-documentation Documentation needs fixing, improving or augmenting. Z2-medium Can be fixed by a coder with good Rust knowledge but little knowledge of the codebase. and removed C3-medium PR touches the given topic and has a medium impact on builders. I3-bug The node fails to follow expected behavior. labels Sep 18, 2020
@stiiifff stiiifff self-assigned this Sep 21, 2020
@stiiifff
Copy link
Contributor

Should be fixed by paritytech/cargo-unleash#17

@gnunicorn
Copy link
Contributor

@stiiifff did you run it against substrate and could send a PR with the updated Readmes, too? Then we can consider this issues fixed, I guess.

@stiiifff
Copy link
Contributor

@gnunicorn will do it now.

@stiiifff stiiifff mentioned this issue Sep 22, 2020
Merged
@ghost ghost closed this as completed in #7176 Sep 22, 2020
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@stiiifff stiiifff

Labels
I6-documentation Documentation needs fixing, improving or augmenting. Z2-medium Can be fixed by a coder with good Rust knowledge but little knowledge of the codebase.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update READMEs, fix links stiiifff/substrate
4 participants
@gnunicorn @stiiifff @bkchr @TriplEight