neurobagel / neurobagel/dev-docs
Proposed sections
Open
Nobody has claimed this yet.
_flag:stale
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Thinking of an initial structure to our internal docs so far:
- Deployment (How do I make this run)
- Process (thinking mainly GitHub Actions and such things, maintaining these)
- Testing (Cypress shenanigans, some pytest tricks)
- Development (code guidelines, setting up dev environments, ...)
- How we work (PR rules ...)
- Lessons learned (we tried this, and learned that ...)
Let's keep the issue open to discuss, we can start moving the docs in parallel
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the proposed section list in this issue and review the existing internal documentation to determine what content belongs in Deployment, Process, Testing, Development, How we work, and Lessons learned. Done means the structure is agreed and the relevant documentation has been moved into those sections, but the issue does not name files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cypress, github-actions
- Domain
- ci-cd, documentation, testing
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100