maj/nextcloud-share
1
0
Fork 0
Code Issues 18 Pull Requests Actions Packages Projects Releases Wiki Activity

Write developer documentation #21

New Issue
Open
opened 2026-01-27 07:08:48 +00:00 by maj · 0 comments
maj commented 2026-01-27 07:08:48 +00:00
Owner
Copy Link

Create developer documentation including architecture, API docs, and contributing guidelines.

Tasks

  • Write architecture overview
  • Generate API docs with Doxygen
  • Document build process
  • Create contributing guidelines
  • Write code style guide
  • Document testing procedures
  • Add platform porting guide
  • Create release process docs
  • Document CI/CD setup

Topics to Cover

  • System architecture diagram
  • Library API reference
  • How to build for each platform
  • How to run tests
  • How to add new platforms
  • Code style requirements
  • PR process
  • Release checklist

Acceptance Criteria

  • Architecture clearly explained
  • API fully documented
  • Build instructions tested
  • Contributing guide complete
  • Code style defined
  • Testing docs clear
  • Porting guide useful
  • Release process documented
Create developer documentation including architecture, API docs, and contributing guidelines. ## Tasks - [ ] Write architecture overview - [ ] Generate API docs with Doxygen - [ ] Document build process - [ ] Create contributing guidelines - [ ] Write code style guide - [ ] Document testing procedures - [ ] Add platform porting guide - [ ] Create release process docs - [ ] Document CI/CD setup ## Topics to Cover - System architecture diagram - Library API reference - How to build for each platform - How to run tests - How to add new platforms - Code style requirements - PR process - Release checklist ## Acceptance Criteria - [ ] Architecture clearly explained - [ ] API fully documented - [ ] Build instructions tested - [ ] Contributing guide complete - [ ] Code style defined - [ ] Testing docs clear - [ ] Porting guide useful - [ ] Release process documented
maj added this to the Milestone 4: Documentation & Polish milestone 2026-01-27 07:08:48 +00:00
maj added the developerdocumentationpriority:medium labels 2026-01-27 07:08:48 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
Bug fix
 bug
Bug fix
 ci-cd
Continuous integration/deployment
 ci-cd
Continuous integration/deployment
 configuration
Configuration management
 configuration
Configuration management
 core
Core functionality
 core
Core functionality
 developer
Developer-focused
 developer
Developer-focused
 distribution
Packaging and distribution
 distribution
Packaging and distribution
 docker
Docker/container related
 docker
Docker/container related
 documentation
Documentation updates
 documentation
Documentation updates
 epic
Epic/milestone tracking issue
 epic
Epic/milestone tracking issue
 feature
New feature
 feature
New feature
 gitea
Gitea-specific
 gitea
Gitea-specific
 infrastructure
Build, CI/CD, setup
 infrastructure
Build, CI/CD, setup
 integration
Integration between components
 integration
Integration between components
 library
Shared library code
 library
Shared library code
 networking
Network/HTTP code
 networking
Network/HTTP code
 platform:3ds
Nintendo 3DS specific
 platform:3ds
Nintendo 3DS specific
 platform:switch
Nintendo Switch specific
 platform:switch
Nintendo Switch specific
 platform:vita
PS Vita specific
 platform:vita
PS Vita specific
 platform:wiiu
Wii U specific
 platform:wiiu
Wii U specific
 priority:high
Must have for release
 priority:high
Must have for release
 priority:low
Nice to have
 priority:low
Nice to have
 priority:medium
Should have
 priority:medium
Should have
 security
Security-related
 security
Security-related
 setup
Setup and initialization
 setup
Setup and initialization
 status:blocked
Blocked by other issues
 status:blocked
Blocked by other issues
 status:in-progress
Currently being worked on
 status:in-progress
Currently being worked on
 status:review
In code review
 status:review
In code review
 task
Implementation task
 task
Implementation task
 testing
Testing and test infrastructure
 testing
Testing and test infrastructure
 ui
User interface
 ui
User interface
 user-facing
User-facing feature or documentation
 user-facing
User-facing feature or documentation
No Label developer documentation priority:medium
Milestone
No items
No Milestone Milestone 4: Documentation & Polish
Projects
Clear projects
No project
Assignees
Clear assignees
maj
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: maj/nextcloud-share#21
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?