Skip to content

Commit cb6b711

Browse files
siujamosiujamo
committed
docs: add docs
1 parent add53d5 commit cb6b711

File tree

31 files changed

+320
-28
lines changed

31 files changed

+320
-28
lines changed

‎src/.vitepress/config.mts

Lines changed: 86 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
import { defineConfig } from "vitepress"
2+
import { projectSidebar } from "./sidebar"
23

34
export default defineConfig({
45
title: "OnixByte Official",
5-
titleTemplate: "OnixByte | :title",
6+
titleTemplate: ":title | OnixByte",
67
description:
78
"OnixByte specialises in delivering cutting-edge technology solutions that drive innovation and empower businesses to excel in the digital era.",
89
locales: {
@@ -17,22 +18,95 @@ export default defineConfig({
1718
{
1819
text: "Projects",
1920
items: [
20-
{ text: "Version Catalogue", link: "/projects/version-catalogue" },
21+
{
22+
text: "Version Catalogue",
23+
link: "/projects/version-catalogue",
24+
},
25+
{ text: "Common Toolkit", link: "/projects/common-toolkit" },
26+
{
27+
text: "Identity Generator",
28+
link: "/projects/identity-generator",
29+
},
30+
{ text: "Crypto Toolkit", link: "/projects/crypto-toolkit" },
31+
{ text: "Math Toolkit", link: "/projects/math-toolkit" },
32+
{
33+
text: "JWT Toolkit",
34+
link: "/projects/jwt-toolkit",
35+
},
2136
],
2237
},
2338
],
2439

25-
sidebar: [
26-
{
27-
text: "Examples",
28-
items: [
29-
{ text: "Markdown Examples", link: "/markdown-examples" },
30-
{ text: "Runtime API Examples", link: "/api-examples" },
31-
],
32-
},
33-
],
40+
sidebar: {
41+
"/opensource": [
42+
{
43+
text: "Open Source Documents",
44+
items: [
45+
{ text: "License", link: "/opensource/license" },
46+
{ text: "Contributing", link: "/opensource/contributing" },
47+
{ text: "Code of Conduct", link: "/opensource/code-of-conduct" },
48+
],
49+
},
50+
{
51+
text: "Open Source Projects",
52+
items: [
53+
{
54+
text: "Version Catalogue",
55+
link: "/projects/version-catalogue",
56+
},
57+
{ text: "Common Toolkit", link: "/projects/common-toolkit" },
58+
{
59+
text: "Identity Generator",
60+
link: "/projects/identity-generator",
61+
},
62+
{ text: "Crypto Toolkit", link: "/projects/crypto-toolkit" },
63+
{ text: "Math Toolkit", link: "/projects/math-toolkit" },
64+
{
65+
text: "JWT Toolkit",
66+
link: "/projects/jwt-toolkit",
67+
},
68+
],
69+
},
70+
],
71+
"/projects/version-catalogue": [
72+
{
73+
text: "Project",
74+
items: projectSidebar("version-catalogue"),
75+
},
76+
],
77+
"/projects/common-toolkit/": [
78+
{
79+
text: "Project",
80+
items: projectSidebar("common-toolkit"),
81+
},
82+
],
83+
"/projects/identity-generator/": [
84+
{
85+
text: "Project",
86+
items: projectSidebar("identity-generator"),
87+
},
88+
],
89+
"/projects/crypto-toolkit/": [
90+
{
91+
text: "Project",
92+
items: projectSidebar("crypto-toolkit"),
93+
},
94+
],
95+
"/projects/math-toolkit/": [
96+
{
97+
text: "Project",
98+
items: projectSidebar("math-toolkit"),
99+
},
100+
],
101+
"/projects/jwt-toolkit/": [
102+
{
103+
text: "Project",
104+
items: projectSidebar("jwt-toolkit"),
105+
},
106+
],
107+
},
34108

35109
socialLinks: [{ icon: "github", link: "https://github.com/onixbyte" }],
36110
},
37-
outDir: "../dist"
111+
outDir: "../dist",
38112
})

‎src/.vitepress/sidebar.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import type { DefaultTheme } from "vitepress/types"
2+
3+
export function projectSidebar(
4+
projectIndex: string
5+
): DefaultTheme.SidebarItem[] {
6+
return [
7+
{ text: "Intro", link: `/projects/${projectIndex}/` },
8+
{ text: "Usage", link: `/projects/${projectIndex}/usage` },
9+
{ text: "API", link: `/projects/${projectIndex}/api` },
10+
{ text: "Changelog", link: `/projects/${projectIndex}/changelog` },
11+
]
12+
}

‎src/index.md

Lines changed: 37 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,44 @@ titleTemplate: ":title"
66

77
hero:
88
name: OnixByte
9-
actions:
10-
- theme: brand
11-
text: Markdown Examples
12-
link: /markdown-examples
13-
- theme: alt
14-
text: API Examples
15-
link: /api-examples
9+
tagline: Building Better, Together.
1610

1711
features:
18-
- title: Feature A
19-
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
20-
- title: Feature B
21-
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
22-
- title: Feature C
23-
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
12+
- title: Open-source Class Libraries
13+
details: |
14+
Our collection of open-source class libraries offers meticulously crafted, reusable components
15+
designed to accelerate your development process. Each library is maintained with rigorous
16+
standards to ensure reliability, efficiency, and ease of integration, empowering developers to
17+
build robust applications with confidence.
18+
- title: Customise Your Project
19+
details: |
20+
Tailor your project to perfectly suit your unique requirements with our flexible and modular
21+
tools. Whether you need to tweak existing components or develop bespoke functionalities, our
22+
solutions provide the adaptability and control to shape your project exactly as envisioned.
2423
---
2524

25+
[//]: # (![Banner](/brand/banner-filled.svg))
26+
27+
## Innovating Development, Empowering Developers
28+
29+
At OnixByte, we aim to simplify and accelerate the software development process through high-quality, open-source tools and frameworks. Whether you're building a robust backend, a sleek frontend, or exploring automation, our resources are designed to meet your needs.
30+
31+
## 🚀 Mission
32+
33+
We are committed to:
34+
35+
- Creating innovative development tools that save time and effort.
36+
- Sharing knowledge and best practices with the developer community.
37+
- Fostering collaboration and building impactful open-source projects.
38+
39+
## ❤️ Join the Community
40+
41+
- **GitHub Discussions**: Ask questions, share ideas, and discuss solutions.
42+
43+
## 📧 Contact Us
44+
45+
Have a question, feedback, or partnership opportunity? Reach out to us!
46+
47+
- Email us: opensource@onixbyte.com
48+
49+

‎src/opensource/code-of-conduct.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Code of Conduct
3+
---
4+
5+
# Code of Conduct
6+
7+
## Our Pledge
8+
9+
We as members, contributors, and leaders pledge to make participation in our project a
10+
harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender
11+
identity and expression, level of experience, nationality, personal appearance, race, religion, or
12+
sexual identity and orientation.
13+
14+
## Our Standards
15+
16+
Examples of behaviour that contributes to creating a positive environment include:
17+
18+
- Using welcoming and inclusive language
19+
- Being respectful of differing viewpoints and experiences
20+
- Gracefully accepting constructive criticism
21+
- Focusing on what is best for the community
22+
- Showing empathy towards other community members
23+
24+
Examples of unacceptable behaviour by participants include:
25+
26+
- The use of sexualised language or imagery, and unwelcome sexual attention or advances
27+
- Trolling, insulting, or derogatory comments
28+
- Personal or political attacks
29+
- Public or private harassment
30+
- Publishing others’ private information, such as a physical or electronic address, without
31+
explicit permission
32+
- Other conduct which could reasonably be considered inappropriate in a professional setting
33+
34+
## Enforcement Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable behaviour and are
37+
expected to take appropriate and fair corrective action in response to any instances of
38+
unacceptable behaviour.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits,
41+
code, wiki edits, issues, and other contributions that do not align with this Code of Conduct, and
42+
will communicate reasons for moderation decisions when appropriate.
43+
44+
## Scope
45+
46+
This Code of Conduct applies both within project spaces and in public spaces when an individual is
47+
representing the project or its community. Examples of representing a project or community include
48+
using an official project email address, posting via an official social media account, or acting as
49+
an appointed representative at an online or offline event.
50+
51+
## Enforcement
52+
53+
Instances of abusive, harassing, or unacceptable behaviour may be reported by contacting the project
54+
team at [report@onixbyte.com](mailto:report@onixbyte.com). All complaints will be reviewed and
55+
investigated and will result in a response that is deemed necessary and appropriate to
56+
the circumstances. The project team is obligated to maintain confidentiality with regard to the
57+
reporter of an incident.
58+
59+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face
60+
temporary or permanent repercussions as determined by other members of the project's leadership.
61+
62+
## Attribution
63+
64+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
65+
version 1.4, available at https://www.contributor-covenant.org/version/1/4/
66+

‎src/opensource/contributing.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Contributing
2+
3+
We appreciate your interest in contributing to our open-source projects. Contributions are welcome
4+
in various forms such as code, documentation, bug reports, and test cases. To ensure a smooth
5+
collaboration, please follow the guidelines outlined below.
6+
7+
## Getting Started
8+
9+
Our libraries are several open-source Java libraries designed to ease Java enterprise application
10+
development. They are built with Amazon Corretto 17.
11+
12+
## Development Setup
13+
14+
There is no need for manual setup beyond ensuring you have Amazon Corretto 17 and a stable internet
15+
connection. Our projects use Gradle Wrapper for building, simplifying the setup process.
16+
17+
```shell
18+
./gradlew build
19+
```
20+
21+
## Branching Strategy
22+
23+
We follow the `git-flow` branching model. Contributors should fork this repository and create their
24+
work on separate branches prefixed with `feature/` or `hotfix/` as appropriate.
25+
26+
## Code Style
27+
28+
Please adhere to the coding standards specified in our `.editorconfig` file in the root of each
29+
repositories. Consistent style helps in maintaining readability and uniformity across the codebase.
30+
31+
## Commit Messages
32+
33+
We require that commit messages follow this structure:
34+
35+
```text
36+
type[(scope)]: subject
37+
38+
[body]
39+
40+
[BREAKING CHANGE: breaking changes]
41+
```
42+
43+
This format helps in auto-generating changelogs and understanding the purpose behind changes.
44+
45+
## Submitting Contributions
46+
47+
1. Fork the repository.
48+
2. Create a branch: `git checkout -b feature/my-new-feature` or `git checkout -b hotfix/my-fix`.
49+
3. Make your changes and commit them.
50+
4. Push to the branch: `git push origin feature/my-new-feature`.
51+
5. Create a Pull Request with a succinct subject and a detailed body.
52+
53+
## Testing
54+
55+
We encourage using JUnit Jupiter for unit and integration tests. Pull Requests with accompanying
56+
test reports are prioritised for review and merging.
57+
58+
## License
59+
60+
By contributing to our open source projects, you agree that your contributions will be licensed
61+
under the MIT license. If you do not agree to this, please refrain from contributing.

‎src/opensource/license.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: License
3+
---
4+
5+
Copyright (c) 2024-2025 OnixByte
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy
8+
of this software and associated documentation files (the "Software"), to deal
9+
in the Software without restriction, including without limitation the rights
10+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the Software is
12+
furnished to do so, subject to the following conditions:
13+
14+
The above copyright notice and this permission notice shall be included in all
15+
copies or substantial portions of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23+
SOFTWARE.

‎src/projects/common-toolkit/api.md

Whitespace-only changes.

‎src/projects/common-toolkit/changelog.md

Whitespace-only changes.

‎src/projects/common-toolkit/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Common Toolkit
3+
---
4+
5+
# {{ $frontmatter.title }}
6+
7+
![OpenSource](https://img.sheilds.io/badge/type-Open_Source)
8+
![License](https://img.shields.io/badge/licence-MIT-green)

‎src/projects/common-toolkit/usage.md

Whitespace-only changes.

0 commit comments

Comments
 (0)