Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs and related tooling #337

Draft
wants to merge 2 commits into
base: developer
Choose a base branch
from
Draft

update docs and related tooling #337

wants to merge 2 commits into from

Conversation

kMutagene
Copy link
Member

@kMutagene kMutagene commented Jul 18, 2024

This PR will

  • update toolchain to use .net 8
  • update to fsdocs 20+
  • remove all TOCs from docs as they are now generated
  • refactor all docs into notebooks

Note that the docs of this repo are somehow cursed. I managed to fix the integration docs, which are currently not displaying output, but somehow broke signal processing and fit quality docs. I think the only solution for this is moving docs from scripts to notebooks, as they have their own mechanism of embedding output. This has the big advantage of writing docs in notebooks though, with markdown rendering and chart embedding. Disadvantage is that i have to copy paste a lot.

Anyways, @bvenn can you maybe try this out locally? maybe the broken docs output is a local problem?

Here is a side-by-side, left and middle are new theme dark/light, right is old theme:

image

@bvenn
Copy link
Member

bvenn commented Jul 24, 2024

Looks great @kMutagene 🚀 Especially the site-index on the right is nice!
Actually, I liked the dark-theme code cells even in the light theme layout, but maybe it just looks more familar and therefore I'm biased 😉
I can reproduce the FitQuality and SignalProcessing and going to have a look at it. Could you provide a minimal working example of how to migrate the docs to notebooks so I can start to copy-paste the contents?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants