Rework docs to use polyglot notebooks
Nobody has claimed this yet.
- Dominant language
- F#
- Stars
- 860
- Forks
- 99
- Avg merge
- 22m
- Merged PRs (30d)
- 1
Description
Since fsdocs now supports generation of documentation with notebooks as input, a rework of the docs that also offers side-by-side examples for F# and C# is overdue.
I think this should be done gradually with a mechanism that allows publishing the new and old docs together as long as not all pages are ported.
This also would be a huge step forward for #376 , at least in a way that we could provide the docs in a format that is needed for the official pipeline.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reviewing fsdocs support for notebook-based documentation and the requirements in issue #376. Determine how new and old documentation can be published together during a gradual migration, then define the scope for side-by-side F# and C# examples and the official pipeline format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, fsharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100