Skip to content
This repository has been archived by the owner on Feb 19, 2024. It is now read-only.

Update docs regarding usage of the analyzer #43

Open
Rekkonnect opened this issue Aug 1, 2021 · 0 comments
Open

Update docs regarding usage of the analyzer #43

Rekkonnect opened this issue Aug 1, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Rekkonnect
Copy link
Owner

Currently, the docs/usage.md file only covers the basics of the analyzer, which are not sufficient through the most recent changes of adding new features. The usage docs should be changed accordingly:

  • Consider the directory docs/guides which will contain such docs about usage of the analyzer
  • usage.md should be split into 4 separate documents, or chapters, that will cover the single most basic feature
  • New docs about profiles and constraint inheritance through all methods should be included
  • Future features will have to abide to that new framework too
@Rekkonnect Rekkonnect added the documentation Improvements or additions to documentation label Aug 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant