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

Migrate all documentation to a website #2315

Open
12 of 19 tasks
nojaf opened this issue Jul 1, 2022 · 0 comments
Open
12 of 19 tasks

Migrate all documentation to a website #2315

nojaf opened this issue Jul 1, 2022 · 0 comments

Comments

@nojaf
Copy link
Contributor

nojaf commented Jul 1, 2022

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

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:

Please tick all that apply:

  • This is not a breaking change to Fantomas
  • 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant