Skip to content

Commit ae6d9d1

Browse files
N3v1N3v1
authored
Merge pull request #4 from ScribbleLabApp/main
(chore): Update from upstream main
2 parents 945cb00 + 1d56aeb commit ae6d9d1

File tree

6 files changed

+218
-29
lines changed

6 files changed

+218
-29
lines changed

‎CONTRIBUTING.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
<!-- Contributing Guidelines Text [START] -->
2+
<!-- Copyright (c) 2024 - ScribbleLabApp LLC -->
3+
4+
# Contributing Guidelines for ScribbleLabApp Documentations
5+
6+
We’re thrilled that you’re considering contributing to ScribbleLab! Every contribution—big or small—helps us grow and create something remarkable for our community.
7+
8+
This guide outlines the expectations and process for contributing. Following these guidelines will ensure a smooth and enjoyable experience for everyone involved. Let’s build something amazing together!
9+
10+
### Table Of Contents
11+
12+
1. [Code of Conduct](#code-of-conduct)
13+
2. [How to Ask Questions](#how-to-ask-questions)
14+
3. [Submitting Issues](#submitting-issues)
15+
4. [Feature Suggestions](#feature-suggestions)
16+
5. [Submitting Pull Requests](#submitting-pull-requests)
17+
6. [Coding Style](#coding-style)
18+
7. [Writing Commit Messages](#writing-commit-messages)
19+
8. [Code Review Process](#code-review-process)
20+
9. [Acknowledgments](#acknowledgments)
21+
10. [Adding Documentation](#adding-documentation)
22+
23+
## Code of Conduct
24+
25+
At ScribbleLab, we strive to create a welcoming, inclusive, and respectful community. Please review and adhere to our Code of Conduct. Disrespectful or harmful behavior will not be tolerated. Let’s work together to maintain a positive and collaborative space.
26+
27+
## How to Ask Questions
28+
29+
Before opening an issue, check our Support Guide.
30+
- Questions about the app or troubleshooting your setup should be addressed in the Discussions tab.
31+
- Issues should focus on bugs, enhancements, or specific feature requests (see below).
32+
33+
## Submitting Issues
34+
35+
Issues help us track bugs and plan improvements. Follow these steps for creating a clear, actionable issue:
36+
37+
### Reporting Bugs
38+
39+
Use the template: Fill out the provided issue template completely. This ensures we have all the context needed to address the problem efficiently.
40+
41+
- Provide details: Include the app version, OS version, reproduction steps, and screenshots or logs, if applicable.
42+
- Search first: Avoid duplicates by checking existing issues. If your bug is already reported, add your input or react to the issue.
43+
44+
If you discover a security vulnerability, please report it privately via our Security Policy. Do not file it as a public issue.
45+
46+
## Feature Suggestions
47+
48+
Got an idea to make ScribbleLab even better? Fantastic! Submit a feature request by following these steps:
49+
50+
1. Search existing requests to avoid duplicates.
51+
2. Use the feature request template to provide:
52+
53+
- A clear description of the feature and its purpose.
54+
55+
- How it complements existing features.
56+
57+
- Mockups or examples, if applicable.
58+
59+
While we review all suggestions, not every idea will fit within our project’s scope. We encourage meaningful discussion and contributions to help refine your idea!
60+
61+
## Submitting Pull Requests
62+
63+
We love contributions! Follow these guidelines to submit your pull request effectively:
64+
65+
1. Discuss first: For significant changes, open an issue or start a discussion before submitting code.
66+
2. One thing at a time: Keep pull requests focused on a single feature or fix. Smaller, atomic changes are easier to review and integrate.
67+
3. Testing matters: Ensure your changes include proper test coverage.
68+
4. Documentation required: Update code comments and relevant documentation to reflect your changes.
69+
5. Follow the style: Maintain consistency with the existing coding style (see below).
70+
71+
> [!Note]
72+
> All contributions are licensed under ScribbleLab’s project license.
73+
74+
## Coding Style
75+
76+
Adhere to the coding style guidelines specified in our [style guide](). Consistent code enhances readability and simplifies maintenance.
77+
78+
To format your code, run `npm run format`.
79+
80+
## Writing Commit Messages
81+
82+
Great commit messages help maintainers understand your changes.
83+
Here’s the preferred format:
84+
85+
```md
86+
(kind): Clear, concise summary of the change
87+
88+
Provide additional context if necessary. Explain the *why* behind your changes, not just the *what*. Reference related issues when applicable.
89+
90+
Resolves: #issue_number
91+
```
92+
93+
Example:
94+
95+
```md
96+
(chore/security): Add AES-256 file encryption for secure notes
97+
98+
Improves security for sensitive content stored in the app. Uses a lightweight C library to ensure fast performance.
99+
100+
Resolves: #42
101+
```
102+
103+
## Code Review Process
104+
105+
Code reviews are a cornerstone of maintaining quality.
106+
- Be constructive: Review code, not the contributor. Offer actionable feedback and explain your reasoning.
107+
- Timely responses: Address review comments promptly to keep the process efficient.
108+
109+
Our team aims to review pull requests within 3-5 business days. Larger changes may take longer.
110+
111+
## Acknowledgments
112+
113+
Your contributions make ScribbleLab better for everyone. Whether you’re reporting a bug, suggesting a feature, or submitting code, your efforts are deeply appreciated.
114+
115+
Let’s collaborate and create something inspiring for the ScribbleLab community! 🚀
116+
117+
## Adding Documentation
118+
119+
We use [Nextra](https://nextra.vercel.app/) and [Next.js](https://nextjs.org/) for our documentation. If you want to add new documentation or improve existing ones, follow these steps:
120+
121+
1. Check our [developer site]() for non-documented topics and guidelines.
122+
2. Create or update markdown files in the
123+
124+
pages
125+
126+
directory.
127+
3. Ensure your documentation follows the structure and style of existing documents.
128+
4. Submit a pull request with your changes.
129+
130+
For more detailed instructions, refer to our [documentation guide]().
131+
132+
<!-- Contributing Guidelines Text [END] -->

‎next.config.ts

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1-
const withNextra = require('nextra')({
1+
import nextra from 'nextra'
2+
3+
const withNextra = nextra({
24
theme: 'nextra-theme-docs',
35
themeConfig: './theme.config.tsx',
4-
});
6+
latex: true,
7+
search: {
8+
codeblocks: false
9+
}
10+
})
511

6-
module.exports = withNextra();
12+
export default withNextra({
13+
reactStrictMode: true
14+
})

‎src/pages/_meta.json

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎src/pages/_meta.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
export default {
2+
index: 'Introduction',
3+
}

‎src/pages/index.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Welcome to ScribbleLabApp docs
2+
3+
Lorem impsum dolor sit amet

‎theme.config.tsx

Lines changed: 69 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,73 @@
1-
import React from 'react';
2-
import { DocsThemeConfig } from 'nextra-theme-docs';
1+
import { useConfig } from 'nextra-theme-docs'
32

4-
const config: DocsThemeConfig = {
5-
logo: <span>My Project</span>,
6-
project: {
7-
link: 'https://github.com/ScribbleLabApp/docs',
8-
},
3+
/* eslint sort-keys: error */
4+
/**
5+
* @type {import('nextra-theme-docs').DocsThemeConfig}
6+
*/
7+
export default {
98
chat: {
10-
link: 'https://discord.com',
9+
link: 'https://discord.gg/Y5mUJbNC8h'
10+
},
11+
docsRepositoryBase:
12+
'https://github.com/ScribbleLabApp/docs',
13+
editLink: {
14+
content: 'Edit this page on GitHub'
1115
},
12-
docsRepositoryBase: 'https://github.com/shuding/nextra-docs-template',
13-
};
16+
project: {
17+
link: 'https://github.com/shuding/nextra'
18+
},
19+
faviconGlyph: '✦',
20+
head: function useHead() {
21+
const config = useConfig()
22+
const title = `${config.title} – ScribbleLabApp Docs`
23+
const description =
24+
config.frontMatter.description || 'Innovate your school life forever with our powerful tools - build by students for students'
25+
const image = config.frontMatter.image || ''
26+
return (
27+
<>
28+
<title>{title}</title>
29+
<meta property="og:title" content={title} />
30+
<meta name="description" content={description} />
31+
<meta property="og:description" content={description} />
32+
<meta name="og:image" content={image} />
33+
34+
<meta name="msapplication-TileColor" content="#fff" />
35+
<meta httpEquiv="Content-Language" content="en" />
36+
<meta name="apple-mobile-web-app-title" content="ScribbleLabApp Docs" />
37+
<meta name="msapplication-TileImage" content="/ms-icon-144x144.png" />
1438

15-
export default config;
39+
<meta name="twitter:card" content="" />
40+
<meta name="twitter:site" content="" />
41+
<link
42+
rel="apple-touch-icon"
43+
sizes="180x180"
44+
href="/apple-icon-180x180.png"
45+
/>
46+
<link
47+
rel="icon"
48+
type="image/png"
49+
sizes="192x192"
50+
href="/android-icon-192x192.png"
51+
/>
52+
<link
53+
rel="icon"
54+
type="image/png"
55+
sizes="32x32"
56+
href="/favicon-32x32.png"
57+
/>
58+
<link
59+
rel="icon"
60+
type="image/png"
61+
sizes="96x96"
62+
href="/favicon-96x96.png"
63+
/>
64+
<link
65+
rel="icon"
66+
type="image/png"
67+
sizes="16x16"
68+
href="/favicon-16x16.png"
69+
/>
70+
</>
71+
)
72+
}
73+
}

0 commit comments

Comments
 (0)