Rework docs to use polyglot notebooks

Open
#442 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
csharp, fsharp
Domain
documentation

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.

Description

Area: Documentation

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.

Dominant language
F#
Stars
860
Forks
99
Avg merge
22m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from plotly/Plotly.NET

All issues in plotly/Plotly.NET

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.