Skip to content

Documentation#60

Open
IrinaMonaEpure wants to merge 15 commits intodevelopfrom
documentation
Open

Documentation#60
IrinaMonaEpure wants to merge 15 commits intodevelopfrom
documentation

Conversation

@IrinaMonaEpure
Copy link

@IrinaMonaEpure IrinaMonaEpure commented Feb 3, 2026

  • Edited config/secrets.env.example to not cause crashing anymore. Added command spcifying the need to copy and edit in in docs/setup.md and README.md. Added explanations in docs/setup.md.
  • Added clear requirements for installing WSL, Docker, Git and links to tutorials depending on operating system in docs/setup.md.
  • Added information on login credentials in docs/setup.md.
  • Created file docs/users-guide.md, which explains how to use class digrams. In the future, we should build up a user manual here, explaining how to use other types of diagram, how to import/export systems as JSON files, etc.
  • Updated README.md with new terminal setup instruction, links to other documentation files, and link to the bug reporting dashboard.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 3, 2026

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.

1 participant