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.

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
merged 5 commits into from
Nov 19, 2024

Conversation

Chafficui
Copy link
Member

@Chafficui Chafficui commented Nov 19, 2024

Description

Set up the initial documentation structure using GitBook and created placeholders for future API documentation.

Related Issue

Closes #5

Type of Change

  • [x ] Documentation update

Checklist

  • My code follows the contribution guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Code coverage remains at or above 80%
  • Commit messages follow the project's commit convention
  • I have updated the CHANGELOG.md file

Additional Notes

- 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 Chafficui added docs Improvements or additions to documentation breaking Breaking change labels Nov 19, 2024
@Chafficui Chafficui added this to the v0.0.1 - Initial Setup milestone Nov 19, 2024
@Chafficui Chafficui self-assigned this Nov 19, 2024
@Chafficui Chafficui linked an issue Nov 19, 2024 that may be closed by this pull request
7 tasks
Copy link

codecov bot commented Nov 19, 2024

Codecov Report

Attention: Patch coverage is 76.92308% with 3 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
.../kotlin/de/chafficplugins/chafficLib/ChafficLib.kt 76.92% 0 Missing and 3 partials ⚠️

Impacted file tree graph

@@           Coverage Diff           @@
##             main       #6   +/-   ##
=======================================
  Coverage        ?   80.00%           
  Complexity      ?        5           
=======================================
  Files           ?        1           
  Lines           ?       15           
  Branches        ?        0           
=======================================
  Hits            ?       12           
  Misses          ?        0           
  Partials        ?        3           
Files with missing lines Coverage Δ Complexity Δ
.../kotlin/de/chafficplugins/chafficLib/ChafficLib.kt 80.00% <76.92%> (ø) 5.00 <5.00> (?)

🚨 Try these New Features:

@Chafficui Chafficui changed the base branch from main to develop November 19, 2024 13:44
@Chafficui Chafficui merged commit 92a83a6 into develop Nov 19, 2024
3 checks passed
@Chafficui Chafficui deleted the docs/5-documentation-structure branch November 19, 2024 13:46
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
Labels
breaking Breaking change docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Structure
1 participant