[Docs] Pull content from README into `lambda-runtime` crate docs / other readmes into other crates
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- rust
- Área
- documentation
Línea de trabajo
Empieza leyendo el README del repositorio y la documentación existente del crate lambda-runtime; después, compara los enfoques propuestos con include_str!, un build.rs personalizado y cargo-readme. El trabajo estará terminado cuando aparezca contenido útil del README en docs.rs para lambda-runtime y exista un camino meditado para lambda-extension y los READMEs de los demás crates que conserve o sustituya adecuadamente la sección de badges.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
We have a fairly rich README in the repository, but very minimalist lambda-runtime docs (same goes for lambda-extension, but i think lambda-runtime is most important). I know the README already shows in GitHub, and on crates.io, but docs.rs adds discoverability as well. It gives the impression that the crate is well-maintained (which it is), whereas sparse docs.rs docs don't look so great.
Even without a full from-scratch crate docs write, I think it would add a lot of value to make some of the content in the README show up in docs.rs.
How to do it
Bad options
Simple include_str!
A simple way to do this would just be to add:
#![doc = include_str!("../../README.md")]
However the first section with all the badges break. So I don't think this is a good option.
include-utils
There is a crate, include-utils, that does pretty much exactly what we need. It would allow only including a subset of the file, so we would include everything after the first section.
However, it would force a new proc macro-based dependency into our primary dependencies, which I don't love. It also seems maintained but is not widely used.
So, I don't think this is a great option either.
Good options
Custom build.rs handling to filter the file
Instead of using the proc macro, we could also just filter the file into what we need via a custom build.rs. This is nice too since then we could replace the badges with regular links to the related crates, which would be kind of nice.
The downside here is a bit of added complexity, but I don't mind knocking it out if desired.
Move most of docs into crate docs, use cargo-readme
The other good option is to flip things around and migrate the source of truth to be the library docs proper. Then the tool cargo-readme lets us generate the markdown README from those.
This has the added benefit of making it really easy to add cross-linking to types and functions inside the crate docs, which is nice.
The downside is that now we need to generate README changes via an extra build step. I guess we could add a pre-commit hook to do it so that nobody forgets?
- Lenguaje dominante
- Rust
- Estrellas
- 3.6k
- Forks
- 397
- Merge medio
- 55 min
- PR fusionados (30 d)
- 1
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de aws/aws-lambda-rust-runtime
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
aws/aws-lambda-rust-runtime#1099 · 1 reacción ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 74/100
aws/aws-lambda-rust-runtime#1165 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
aws/aws-lambda-rust-runtime#1161 ·
-
aws/aws-lambda-rust-runtime#1155 · 1 reacción · 1 asignado ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
aws/aws-lambda-rust-runtime#1131 · 1 comentario ·
Todos los issues de aws/aws-lambda-rust-runtime
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
TheLarkInn/aipm#2413 ·
-
documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
alexgorbatchev/simple-ptt#15 ·
-
tooling
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
todo:ticket
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
taikoxyz/taiko-mono#22168 · 1 comentario ·