Use Roslynator for docs?
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- csharp, markdown
- Domain
- documentation, tooling
Research direction
Start with Gutenberg/Gutenberg.csproj and run the proposed Roslynator command to inspect the generated markdown. Determine whether the project should adopt this documentation workflow, choose a markdown renderer, and define how C# syntax highlighting would work; the issue is done when those integration decisions are resolved and documented.
Written by the indexing model from the issue text.
Description
Roslynator can cook xmldocs into markdown pages, seems faster and better supported than docfx. Then the markdown can be displayed with whatever static site generator you like. There's built in support for Docusaurus-flavoured-markdown and Sphinx, but can also use starlight or Hakyll or MkDocs or whatever other markdown renderer.
roslynator generate-doc Gutenberg/Gutenberg.csproj -o my-website/docs --heading Gutenberg --host docusaurus --group-by-common-namespace
Would need to figure out C# syntax highlighting.
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
agent/quality hive/hosted-available-lke648397-260827-5n31 quality testing
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 Half a day Newbie friendliness 78/100
jaegertracing/jaeger-ui#4512 ·
Maintainers usually reply within 1 day
-
feedback simulation workshop
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
githubnext/gh-aw-workshop#3857 ·
Maintainers usually reply within 2 days
-
area-clientside-dartpad
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
quarkusio/extensions#3432 ·
Maintainers usually reply within 1 day