Skip to content

Potential documentation improvements #67

Description

@DariuszRozmus

Potential documentation improvements
Home → What does the author mean by Docker and local?
Frontend Demo → “Pull the converter submodule” — it might be a good place to explain why this is needed, because right now it feels like an instruction without context.
Contribution → Maybe add a note about squash commit pull requests.
Backend Database → Can we add a schema?
Simulation Lifecycle → Are there only POST requests?
Submodules → Maybe add a sentence like: “We use GitHub submodules, which allow us to ...” or include this in the glossary.
UI repo README → The link is incorrect.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions