Skip to content
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

Triage .md files #1260

Open
ggwpez opened this issue Aug 29, 2023 · 4 comments
Open

Triage .md files #1260

ggwpez opened this issue Aug 29, 2023 · 4 comments
Labels
T11-documentation This PR/Issue is related to documentation.

Comments

@ggwpez
Copy link
Member

ggwpez commented Aug 29, 2023

There are a few .adoc files in the workspace - most of them looking rather unuseful.
I think we should either remove them or fix and convert to markdown with some tool so we can use MD tooling eventually #1243.

cc @paritytech/docs-audit (not sure if you are the right to mention here?!)

@kianenigma kianenigma added the T11-documentation This PR/Issue is related to documentation. label Sep 7, 2023
@kianenigma
Copy link
Contributor

kianenigma commented Sep 7, 2023

I would no-brainer say remove all .adoc and .md files that are acting as code doc, and instead replace them as rust-doc.

We should double down on rust-doc and encourage everyone to read those.

Also in the spirit of #991

@ggwpez
Copy link
Member Author

ggwpez commented Sep 7, 2023

Actually all adoc were removed in #1382, but there are still oneliner README files so going to change that title here.

@ggwpez ggwpez changed the title Triage .adoc files Triage .md files Sep 7, 2023
@Rashmirreddy Rashmirreddy moved this to To Do in Documentation Sep 11, 2023
@kianenigma
Copy link
Contributor

Now that we are releasing to crates.io, we should make sure we remove all these files, and run https://docs.rs/crate/cargo-markdown/1.0.3 as a part of our of release to crate.io process.

@ggwpez
Copy link
Member Author

ggwpez commented Oct 2, 2023

Or try this tool? https://github.com/webern/cargo-readme The cargo-mardown from above looks like it only previews things instead of also generating.

So we probably want a script that does this for all crates and then trigger it once before each release.
@Morganamilo is there a pre-release checklist or something where we could add this as item?

serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 8, 2024
serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 8, 2024
serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 8, 2024
serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 8, 2024
serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 9, 2024
serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 10, 2024
serban300 pushed a commit to serban300/polkadot-sdk that referenced this issue Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T11-documentation This PR/Issue is related to documentation.
Projects
Status: To Do
Development

No branches or pull requests

2 participants