fsprojects
Migrate all documentation to a website
I propose we have a single place where we host all documentation. Following other F# projects, it makes sense that we use FsDoc for this.
The existing way of Fantomas deals with this problem is through different markdown files, blogposts and videos spread over multiple platforms.
Premise
The documentation should cover multiple topics and should really be the place to look at for both end-users and contributors. This issue will be used to bundle all the action points, if there are any community suggestions I'd be happy to discuss them here.
Technical
We should have our own theme in FsDocs to have full control of what we are trying to achieve. Make sure of Bootstrap and Sass (using the Sass style, not the Scss flavour), similar to how the landing page is constructed.
Be inspired by other visually pleasing documentation websites (Arrow is a good example). And respect our new branding guidelines. Use the correct colours and font (notice that you should use Reem Kufi, that part of the guide needs an update).
Principles
As mentioned on our Discord channel, please visit https://documentation.divio.com/ to capture everything we need on our documentation website.
Work
- [X] Create initial landing page
- [x] https://github.com/fsprojects/fantomas/issues/2316
- [x] https://github.com/fsprojects/fantomas/issues/2317
- [x] https://github.com/fsprojects/fantomas/issues/2318
- [x] https://github.com/fsprojects/fantomas/issues/2319
- [x] https://github.com/fsprojects/fantomas/issues/2320
- [ ] https://github.com/fsprojects/fantomas/issues/2321
- [x] https://github.com/fsprojects/fantomas/issues/2322
- [x] https://github.com/fsprojects/fantomas/issues/2323
- [x] https://github.com/fsprojects/fantomas/issues/2324
- [ ] https://github.com/fsprojects/fantomas/issues/2325
- [x] https://github.com/fsprojects/fantomas/issues/2329
- [x] https://github.com/fsprojects/fantomas/issues/2330
Extra information
Estimated cost (XS, S, M, L, XL, XXL): L / XL
Affidavit (please submit!)
Please tick this by placing a cross in the box:
- [x] I have read the Contribution Guidelines.
- [x] I have searched both open and closed suggestions on this site and believe this is not a duplicate
Please tick all that apply:
- [x] This is not a breaking change to Fantomas
- [x] I or my company would be willing to help implement and/or test this
- [ ] This suggestion is part of the Microsoft style guide
- [ ] This suggestion is part of the G-Research style guide
