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

Improve developer documentation #3276

Closed
moritz-suckow-mw opened this issue Apr 21, 2023 · 2 comments
Closed

Improve developer documentation #3276

moritz-suckow-mw opened this issue Apr 21, 2023 · 2 comments
Assignees
@ce-bo
Labels
difficulty:low Solving this is likely not that difficult documentation good first issue priority:high Set by PO

Comments

@moritz-suckow-mw
Copy link
Contributor

Feature request

Description

As a developer, I want to have a centralised documentation with information for getting started so that I do not have to search through multiple files at multiple locations for all needed information.

Acceptance criteria

  • There is a getting started page in the documentation with all needed information for starting development in one place
  • From there I can navigate to more specific getting started pages for the analysis and visualisation parts of the project

Background

Right now the documentation for developing is scattered around multiple files in the repository and rather small. A more extensive and centralised developer documentation would help new developers get started faster in the project.
@ce-bo ce-bo added priority:high Set by PO difficulty:low Solving this is likely not that difficult labels Apr 21, 2023
@ce-bo ce-bo self-assigned this Apr 27, 2023
@ce-bo
Copy link
Collaborator

ce-bo commented Apr 27, 2023

Let's address this soonish as long as the difficulties are still known.

moritz-suckow-mw added a commit that referenced this issue May 8, 2023
@moritz-suckow-mw
Expand developer documentation #3276
c32fe0c
@moritz-suckow-mw moritz-suckow-mw mentioned this issue May 8, 2023
Merged
moritz-suckow-mw added a commit that referenced this issue May 8, 2023
@moritz-suckow-mw
Add changelog entry #3276
fca4b40
moritz-suckow-mw added a commit that referenced this issue May 15, 2023
@moritz-suckow-mw @phanlezz
docs/3276/improve-getting-started (#3289)
35dd8a0 
* Expand developer documentation #3276

---------

Co-authored-by: Phanlezz <[email protected]>
@moritz-suckow-mw
Copy link
Contributor Author

closed via #3289

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

@ce-bo ce-bo

Labels
difficulty:low Solving this is likely not that difficult documentation good first issue priority:high Set by PO
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ce-bo @moritz-suckow-mw