Skip to content

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?

@kMutagene kMutagene changed the base branch from developer to datascience August 9, 2025 11:29
@kMutagene kMutagene marked this pull request as ready for review August 10, 2025 12:53
@kMutagene kMutagene merged commit 8f85c12 into datascience Aug 10, 2025
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.

4 participants