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

Initial documentation website #89

Merged
merged 12 commits into from
Sep 12, 2023
Merged

Initial documentation website #89

merged 12 commits into from
Sep 12, 2023

Conversation

nojaf
Copy link
Contributor

@nojaf nojaf commented Sep 12, 2023

image

@dawedawe and I wish to add more documentation to encourage people to write their own analyzers.
So far I have:

  • done an initial fsharp.formatting setup
  • enjoyed myself with some CSS
  • Added a first very basic page with Getting started

Other ideas (for later PRs) we have are:

  • A recipe page, where we elaborate on how certain information can be acquired from the Context.
  • Adding a guide on writing unit tests
  • An overview of existing analyzers in the wild.
  • Implement search via Algolia.
  • Try and set up a way to view docs per released version.

All of this is WIP but I think this is a good enough first chunk for now.

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