Skip to content

Migrate docs to DocFX#147

Open
gumbarros wants to merge 2 commits into
robinrodricks:developfrom
gumbarros:develop
Open

Migrate docs to DocFX#147
gumbarros wants to merge 2 commits into
robinrodricks:developfrom
gumbarros:develop

Conversation

@gumbarros

@gumbarros gumbarros commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Fixes

Issue #145

Description

This PR migrates the contents from the GitHub wiki without any changes (except the links) to DocFX.

To check by yourself

dotnet tool install -g docfx

cd docs

docfx metadata

docfx build --serve

Showcase

image image image

Additional comments

If you don't like the layout, we can use any of these themes or create one from scratch like NCalc.

I liked the result, I think this will greatly improve the SEO of the project and the public API section is very welcome for undocumented classes. I also think there is a lot of work to do, like better docs for some providers, re-work the menu and docs for provider agnostic usage like listing files, rename, create folder behavior etc.

@gumbarros

Copy link
Copy Markdown
Contributor Author

Also, I did not create any CI in this PR because I dont know if you will approve, but can be easily configured like this

@robinrodricks

Copy link
Copy Markdown
Owner

Looks good. I'll look thru the themes later. Can we rename the "Articles" button to "Wiki". And where will it be hosted? I would like it to be hosted on github itself using static sites as I would not like to redirect traffic to a 3rd party.

@gumbarros

Copy link
Copy Markdown
Contributor Author

Looks good. I'll look thru the themes later. Can we rename the "Articles" button to "Wiki". And where will it be hosted? I would like it to be hosted on github itself using static sites as I would not like to redirect traffic to a 3rd party.

Sure, and the CI pipeline I share will publish to

yourusername.github.io/fluentstorage

Except if you create a GitHub org for FluentStorage, then it will be fluentstorage.github.io/fluentstorage

@robinrodricks

Copy link
Copy Markdown
Owner

Hi, what does the PR do? It generates HTML? Where is the HTML placed? I will need to make another repo for fluentstorage as a github website and copy those HTML into that repo.

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