chore: update repository documentation#98
Merged
liamnwhite1 merged 10 commits intodevelopfrom Dec 9, 2025
Merged
Conversation
- style guide for project coding standards - formatting guidelines using clang-format - Conventional Commits guidelines for commit message standards - Doxygen documentation guidelines - Conventional Branch Naming Guide for clarity and consistency - pull request guidelines - issue submission guide
- Slicer2.gif - GPU acceleration documents - Abstract Slicing.pdf - Generating Master Configuration.pdf - todo.txt - custom.md
liamnwhite1
requested review from
AshGannon,
aroschli,
cadkin and
mborish
as code owners
- slicer-2 user guide PDF - slicer-2 QR code image - slicer-2 logo image
liamnwhite1
force-pushed
the
chore/update-documentation
branch
from
204a104 to
1960bd1
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
depends: #97
This pull request introduces major improvements to project documentation, issue tracking, and contribution workflow. The changes standardize templates for issues and pull requests, add a comprehensive contribution guide, and overhaul the
README.mdfor clarity and onboarding. Additionally, a new Doxygen layout is provided for better API documentation structure.Documentation & Onboarding Enhancements
README.mdto provide a clear project overview, feature list, support channels, documentation links, onboarding instructions, and contributor acknowledgments. Improved formatting and updated images.CONTRIBUTING.mdguide outlining workflow, branch naming, commit conventions, PR process, style, formatting, and documentation expectations for maintainers and contributors.DoxygenLayout.xmlto define the navigation and layout for API documentation, improving the structure and usability of generated docs.Issue & PR Template Standardization
bug_report.mdfor bugs anddevelopment_task.mdfor tasks/feature requests, ensuring consistent and complete issue submissions. [1] [2]custom.md) to avoid confusion and enforce use of the new standardized templates.pull_request_template.md) to guide contributors in documenting changes, context, testing, and review notes.Assets and Miscellaneous
slicer-2_logo.png) to the assets directory for branding and documentation use.These updates make it easier for new contributors to get started, improve the quality of reported issues and submitted PRs, and enhance the overall maintainability and professionalism of the project.