-
Notifications
You must be signed in to change notification settings - Fork 90
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove generate_doc
feature
#484
Conversation
Signed-off-by: Jorge Prendes <[email protected]>
a81c4bc
to
962ab39
Compare
@@ -1,36 +0,0 @@ | |||
A library to help build containerd shims for wasm workloads. | |||
|
|||
## Usage |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is the usage doc being removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is ## Usage
is duplicated in README.md
.
It was basically cat doc/header.md doc/doc.md > README.md
This PR proposes not using doc/*.md
, and just work on README.md
directly.
@@ -1,4 +1,4 @@ | |||
![runwasi logo](../../art/logo/runwasi_logo_icon.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will other links in the Main readme that are relative still work?
I.E.
Line 269 in 868a06a
The test binary supports commands for different type of functionality, check [crates/wasi-demo-app/src/main.rs](crates/wasi-demo-app/src/main.rs) to try it out. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's no change in that respect.
The text sourced for the doc is exactly the same (modulo now including the logo).
Also this only concerns the containerd-shim-wasm
crate's README.md
, which is different from the project's README.md
and doesn't have any relative links other than the image.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah I missed that it wasn't the projects readme and only the crate readme.
Looks like there is some duplication between the crate readme and the main readme that should probably be moved the to crate readme and referenced from the main.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This PR removes the
generate_doc
feature.The expectation is that updating
README.md
should be done directly.