Remove generate_doc feature
#484
Conversation
Signed-off-by: Jorge Prendes <[email protected]>
jprendes
force-pushed
the
remove-generate_doc
branch
from
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.
Why is the usage doc being removed?
There was a problem hiding this comment.
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 @@ | |||
|  | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
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.
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.
This PR removes the
generate_docfeature.The expectation is that updating
README.mdshould be done directly.