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.

Sign up for GitHub

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

Jump to bottom

First Iteration of a Documentation on Hephaestus #201

Open
3 of 12 tasks
GODrums opened this issue Dec 3, 2024 · 0 comments
Open
3 of 12 tasks

First Iteration of a Documentation on Hephaestus #201

GODrums opened this issue Dec 3, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@GODrums
Copy link
Collaborator

GODrums commented Dec 3, 2024 •
edited
Loading

Objective

With the increase in complexity of our code, we require a explicit documentation to prevent information loss and preserve good coding standards.

Hephaestus docs: https://ls1intum.github.io/Hephaestus/
Artemis docs: https://docs.artemis.cit.tum.de/

Tasks

  • Setup guide -> Docs: Setup Guide Page #213
    • Server setup:
      • application-local.yml - which values exist and what do they change?
      • MVN / NPM commands
    • Client setup
  • Coding and Design guidelines
    • Server
    • Client
    • Database
  • System Design
    • TLD
    • Data Model
    • Deployment?
  • Data Migration (Liquibase)
@GODrums GODrums added the documentation Improvements or additions to documentation label Dec 3, 2024
@GODrums GODrums mentioned this issue Dec 10, 2024
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@GODrums