-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
docs: Set up initial documentation structure (#5) #6
Merged
Conversation
This file contains 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
- Added GitBook configuration - Created documentation outline - Added getting started guide - Added installation guide - Set up API documentation structure - Added placeholder pages for future content
- Configure GitHub Pages deployment - Include both Dokka and GitBook documentation - Update permissions for Pages deployment
- Added GitBook configuration and outline - Created getting started and installation guides - Added API documentation structure with placeholders - Set up KDoc/Dokka configuration Closes #5
Chafficui
added
docs
Improvements or additions to documentation
breaking
Breaking change
labels
Nov 19, 2024
Closed
7 tasks
Chafficui
temporarily deployed
to
github-pages
November 19, 2024 13:14 — with
GitHub Actions
Inactive
Codecov ReportAttention: Patch coverage is
@@ Coverage Diff @@
## main #6 +/- ##
=======================================
Coverage ? 80.00%
Complexity ? 5
=======================================
Files ? 1
Lines ? 15
Branches ? 0
=======================================
Hits ? 12
Misses ? 0
Partials ? 3
🚨 Try these New Features:
|
Chafficui
temporarily deployed
to
github-pages
November 19, 2024 13:19 — with
GitHub Actions
Inactive
Chafficui
temporarily deployed
to
github-pages
November 19, 2024 13:33 — with
GitHub Actions
Inactive
Chafficui
temporarily deployed
to
github-pages
November 19, 2024 13:37 — with
GitHub Actions
Inactive
Chafficui
temporarily deployed
to
github-pages
November 19, 2024 13:38 — with
GitHub Actions
Inactive
Chafficui
temporarily deployed
to
github-pages
November 19, 2024 13:39 — with
GitHub Actions
Inactive
Chafficui
temporarily deployed
to
github-pages
November 19, 2024 13:40 — with
GitHub Actions
Inactive
Chafficui
added a commit
that referenced
this pull request
Nov 26, 2024
* docs: Set up initial documentation structure (#5) (#6) * docs: set up initial documentation structure - Added GitBook configuration - Created documentation outline - Added getting started guide - Added installation guide - Set up API documentation structure - Added placeholder pages for future content * docs(ci): add documentation deployment to GitHub Pages - Configure GitHub Pages deployment - Include both Dokka and GitBook documentation - Update permissions for Pages deployment * docs: set up initial documentation structure - Added GitBook configuration and outline - Created getting started and installation guides - Added API documentation structure with placeholders - Set up KDoc/Dokka configuration Closes #5 * fix(docs): remove ./docs from dokka upload * chore(ci): remove pages deployment from build workflow --------- Co-authored-by: Chafficui <[email protected]> * bug migrate to mockbukkit 4 (#15) (#16) * chore(upgrade): upgrade MockBukkit to version 4 * fix(build): fix warning to dokka buildDir * refactor(test): remove unused tick method --------- Co-authored-by: Chafficui <[email protected]> * chore(test): add junit params to testImplementation * feat: implement helper enum for inventory sizes * feat: implement base gui system * feat: implement inventory templates for easier building * test: add inventory size tests * fix(test): downgrade paper version to match mockbukkit dependencies * test: add tests for inventory builder * test(gui): add comprehensive template tests - Added detailed tests for BorderTemplate - Added tests for template application - Added tests for custom templates - Improved test utilities for MockBukkit 4.0 - Achieved >80% test coverage --------- Co-authored-by: Chafficui <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Set up the initial documentation structure using GitBook and created placeholders for future API documentation.
Related Issue
Closes #5
Type of Change
Checklist
Additional Notes