[Docs][CI] Ensure docfx links stay valid, prepare future xml API docs options, keep docs simple maintainable and introduce CI integration for this
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- csharp, github-actions
- Área
- build-system, ci-cd, documentation
Línea de trabajo
Comienza revisando docfx.json, commitlint.yml, los workflows existentes de GitHub Actions y el issue relacionado #845. El issue contiene varios enfoques posibles para CI, ramas, etiquetado y documentación de API, sin un alcance definido. Para darlo por terminado sería necesario contar con un diseño acordado y una validación funcional que garantice que los enlaces de la documentación generada sigan siendo válidos.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
This Docs/CI Enhancement targets to keep pre / development Branch Docs + Releases API:
- cleanly seperated on their branch (intellisense/markdown suggestion support)
- allow valid API docs and source code linking in docs
[!IMPORTANT]
docfx docs generation will fail completly or produce invalid Links if we include the metadata step on a branch that doesn't include the to be linked file or src code!
To Ensure the latest docs PR (find linked in Additional Information Section) will not fall on our toes in the future or cause unnessesary additional (automate-able) work for us, we should consider:
-
GH Action for PR's md docs changes: If there are only md docs changes (our current build not includes API docs) This should get triggered and add a PR for maybe cherry picking those commits from development onto master? but this will potentially be causing invalid links as soon as we step on to use API docs!
-
Enhance/Ensure proper Commit Labels: We should then explicitly keep our commits cleanly seperated and scoped/categorized properly, which would include such relevant changes. It's possible for the commitlint.yml from what I readed by now, to add more allowed labels or similar but we should have this discussed and decided properly, what we want and maybe find ways to do this, which I maybe did possibly not consider here.
-
GH Action: Ensure DocFx correct build for API metadata: Pay Attention as soon as we might want to use generate xml docs from any source code via metadata!
Produce and add API Docs after changes on non-master-merge PR branches:- create the API them in this case after their source branch got a relevant PR merge
- have all docfx docs produced and merged to master (?) or @andrerav what do you think of reusing the
gh-pagesbranch for our docs product then 🤔 ? possibly this is the cleanest way...
-
Review & Add DocFx
ContentSetup for API version support:I havn't been successfull by now with the
output/destsettings indocfx.jsonwhich are linted asdepreciatedbut I see many others still use them and I think this is required to have a proper xml API output control for this 🤔-
Possibly I will need to ask the docfx team for help, to come to a working setup, but my targeted idea would be something like this in our github.io web docs then:
-
Additional Information
- #845
@DocSvartz @stagep @andrerav
- Lenguaje dominante
- C#
- Estrellas
- 5.2k
- Forks
- 411
- Merge medio
- 1 d 8 h
- PR fusionados (30 d)
- 4
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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 MapsterMapper/Mapster
-
.NET MatrixAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
MapsterMapper/Mapster#1003 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 58/100
MapsterMapper/Mapster#1024 · 1 comentario ·
-
[Mapster Tool] Add support for global:: to disambiguate type names in generated mappersPosiblemente ocupada @DocSvartz la tomó hace 3 días. Abiertoimprovement
Dificultad 3/5 1-2 días Aptitud para principiantes 65/100
MapsterMapper/Mapster#1020 · 5 comentarios ·
-
Mapster.Tool - PropertySettingBuilder.Map(member, mapFunc, targetPropertyName) method is not working as expected!Posiblemente ocupada Un pull request vinculado a esta issue está abierto o ya se fusionó. Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
MapsterMapper/Mapster#1017 · 6 comentarios ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 57/100
MapsterMapper/Mapster#1007 · 5 comentarios ·
Todos los issues de MapsterMapper/Mapster
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
-
[Bug]: Revit selector reads process ids 2000-2099 as years (flaky AgentClientTests.AYearOrAProcessIdSelectsTheHost)Posiblemente ocupada @Wurschdhaud la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 83/100
pyrevitlabs/pyRevit#3817 ·
Los mantenedores suelen responder en 1 día
-
bug effort:S P2
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
nightscout/nocturne#2449 ·
Los mantenedores suelen responder en 1 día
-
Python: Rejected system messages leave AgentChat permanently activePosiblemente ocupada @Michael-Duck la tomó hoy. Abiertopython triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
microsoft/semantic-kernel#14638 ·
Los mantenedores suelen responder en 3 días
-
audit:1 bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
NethermindEth/dotnet-libp2p#395 ·
Los mantenedores suelen responder en 1 día