Skip to content

Commit

Permalink
(chore): Format pages
Browse files Browse the repository at this point in the history
  • Loading branch information
N3v1 committed Nov 25, 2024
1 parent 6f0e726 commit 64b2e53
Show file tree
Hide file tree
Showing 43 changed files with 470 additions and 433 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/a11y.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: 🌎 [i18n] Translation Issue
description: Report a translation issue.
title: "[i18n]: {Title}"
title: '[i18n]: {Title}'
labels:
- "scope: i18n"
- 'scope: i18n'

body:
- type: markdown
Expand Down Expand Up @@ -51,4 +51,4 @@ body:
description: Please search to see if an issue already exists for the translation issue you encountered.
options:
- label: I have searched the existing issues
required: true
required: true
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: 🔴 Bug report
description: Something is not working as expected.
title: "[BUG]: {description}"
labels:
- "type: bug"
- "needs review"
title: '[BUG]: {description}'
labels:
- 'type: bug'
- 'needs review'

body:
- type: markdown
Expand Down Expand Up @@ -69,4 +69,4 @@ body:
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
required: true
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ contact_links:
- name: ScribbleLab Comunity
url: https://discord.gg/Y5mUJbNC8h
about: Connect with our developers and other community members
- name: ScribbleLabApp Support
url:
about: Request a ticket for support
- name: Frequently Asked Questions (FAQ)
url: https://github.com/ScribbleLabApp/docs/tree/main
about: Find answers to common questions
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/page_request.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: ✨ Page Request
description: Suggest an idea for further documentation pages or claim a page to write about.
title: "[preq]: {title}"
labels: "enhancement"
title: '[preq]: {title}'
labels: 'enhancement'

body:
- type: textarea
Expand Down Expand Up @@ -37,4 +37,4 @@ body:
description: Please search to see if an issue already exists for the feature you encountered.
options:
- label: I have searched the existing issues
required: true
required: true
8 changes: 7 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,15 @@ Explain what has been changed and why, with context that will help the reviewer
-->

## How Has This Been Tested?

Describe the steps you took to verify that your changes are accurate and render correctly (e.g., reviewing the page locally, checking for broken links, etc.).

- [ ] The documentation renders correctly after the change.
- [ ] There are no broken links in the document.
- [ ] The formatting is correct (headings, bullet points, code blocks, etc.).

## Checklist

Please ensure your pull request meets the following criteria before submitting:

- [ ] I have read and followed the [Contributing Guidelines](https://github.com/yourusername/scribblelabapp/blob/main/CONTRIBUTING.md).
Expand All @@ -47,12 +49,16 @@ Please ensure your pull request meets the following criteria before submitting:
- [ ] I have not included unnecessary changes or files.

## Screenshots or Examples (if applicable)

If you made any changes that affect the visual presentation (e.g., layout, images, or code examples), include a screenshot or example to show how it appears.

## Related Issues or Links

If this change is part of a larger discussion or issue, include any relevant issue links or related pages:

- Related issue: #[Issue Number]
- Relevant documentation pages: [Link to page]

## Additional Notes
If there’s anything else that you think the reviewer should know or any additional context you’d like to provide, include it here.

If there’s anything else that you think the reviewer should know or any additional context you’d like to provide, include it here.
6 changes: 3 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: "weekly"
interval: 'weekly'
3 changes: 2 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
node_modules/
.next/
out/
public/
public/
src/pages/contributing/documentation.mdx
42 changes: 22 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ This guide outlines the expectations and process for contributing. Following the

### Table Of Contents

1. [Code of Conduct](#code-of-conduct)
2. [How to Ask Questions](#how-to-ask-questions)
3. [Submitting Issues](#submitting-issues)
4. [Feature Suggestions](#feature-suggestions)
5. [Submitting Pull Requests](#submitting-pull-requests)
6. [Coding Style](#coding-style)
7. [Writing Commit Messages](#writing-commit-messages)
8. [Code Review Process](#code-review-process)
9. [Acknowledgments](#acknowledgments)
1. [Code of Conduct](#code-of-conduct)
2. [How to Ask Questions](#how-to-ask-questions)
3. [Submitting Issues](#submitting-issues)
4. [Feature Suggestions](#feature-suggestions)
5. [Submitting Pull Requests](#submitting-pull-requests)
6. [Coding Style](#coding-style)
7. [Writing Commit Messages](#writing-commit-messages)
8. [Code Review Process](#code-review-process)
9. [Acknowledgments](#acknowledgments)
10. [Adding Documentation](#adding-documentation)

## Code of Conduct
Expand All @@ -27,6 +27,7 @@ At ScribbleLab, we strive to create a welcoming, inclusive, and respectful commu
## How to Ask Questions

Before opening an issue, check our Support Guide.

- Questions about the app or troubleshooting your setup should be addressed in the Discussions tab.
- Issues should focus on bugs, enhancements, or specific feature requests (see below).

Expand All @@ -48,25 +49,25 @@ If you discover a security vulnerability, please report it privately via our Sec
Got an idea to make ScribbleLab even better? Fantastic! Submit a feature request by following these steps:

1. Search existing requests to avoid duplicates.
2. Use the feature request template to provide:
2. Use the feature request template to provide:

- A clear description of the feature and its purpose.
- A clear description of the feature and its purpose.

- How it complements existing features.
- How it complements existing features.

- Mockups or examples, if applicable.
- Mockups or examples, if applicable.

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!

## Submitting Pull Requests

We love contributions! Follow these guidelines to submit your pull request effectively:

1. Discuss first: For significant changes, open an issue or start a discussion before submitting code.
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.
3. Testing matters: Ensure your changes include proper test coverage.
4. Documentation required: Update code comments and relevant documentation to reflect your changes.
5. Follow the style: Maintain consistency with the existing coding style (see below).
1. Discuss first: For significant changes, open an issue or start a discussion before submitting code.
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.
3. Testing matters: Ensure your changes include proper test coverage.
4. Documentation required: Update code comments and relevant documentation to reflect your changes.
5. Follow the style: Maintain consistency with the existing coding style (see below).

> [!Note]
> All contributions are licensed under ScribbleLab’s project license.
Expand All @@ -85,7 +86,7 @@ Here’s the preferred format:
```md
(kind): Clear, concise summary of the change

Provide additional context if necessary. Explain the *why* behind your changes, not just the *what*. Reference related issues when applicable.
Provide additional context if necessary. Explain the _why_ behind your changes, not just the _what_. Reference related issues when applicable.

Resolves: #issue_number
```
Expand All @@ -103,6 +104,7 @@ Resolves: #42
## Code Review Process

Code reviews are a cornerstone of maintaining quality.

- Be constructive: Review code, not the contributor. Offer actionable feedback and explain your reasoning.
- Timely responses: Address review comments promptly to keep the process efficient.

Expand All @@ -125,4 +127,4 @@ We use [Nextra](https://nextra.vercel.app/) and [Next.js](https://nextjs.org/) f

For more detailed instructions, refer to our [documentation guide]().

<!-- Contributing Guidelines Text [END] -->
<!-- Contributing Guidelines Text [END] -->
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
51 changes: 25 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# ScribbleLabApp Community Product Documentation

Welcome to the official community product documentation for ScribbleLabApp. This README provides comprehensive details on using ScribbleLabApp, contributing to the project, and engaging with the developer community. Whether you’re a new user or a contributor, you’ll find everything you need to get started.
Expand All @@ -7,14 +6,14 @@ Welcome to the official community product documentation for ScribbleLabApp. This

### Table of Contents

1. [Introduction](#introduction)
2. [Features](#features)
3. [Getting Started](#getting-started)
4. [Usage](#usage)
5. [Contributing](#contributing)
6. [Community](#community)
7. [License](#license)
8. [Contact](#contact)
1. [Introduction](#introduction)
2. [Features](#features)
3. [Getting Started](#getting-started)
4. [Usage](#usage)
5. [Contributing](#contributing)
6. [Community](#community)
7. [License](#license)
8. [Contact](#contact)

## Introduction

Expand Down Expand Up @@ -43,27 +42,27 @@ To get started with ScribbleLabApp, follow these steps:

1. Clone the repository to your local machine:

```bash
git clone https://github.com/ScribbleLabApp/docs.git
```
```bash
git clone https://github.com/ScribbleLabApp/docs.git
```

2. Navigate into the project directory:
2. Navigate into the project directory:

```bash
cd docs
```
```bash
cd docs
```

3. Install the required dependencies:
3. Install the required dependencies:

```bash
npm install
```
```bash
npm install
```

4. Start the development server:
4. Start the development server:

```bash
npm run dev
```
```bash
npm run dev
```

After completing these steps, you’ll be able to run and access the ScribbleLabApp Community Product Documentation on your local machine.

Expand All @@ -77,10 +76,10 @@ For a deeper dive into how to utilize ScribbleLabApp, refer to the User Guide fo

We welcome contributions from the community! Whether you’re fixing bugs, suggesting features, or improving documentation, your involvement helps make ScribbleLabApp even better. To contribute, please follow our [Contribution Guide](CONTRIBUTING.md).


## Community

Join the ScribbleLabApp community to stay up to date, ask questions, and share your feedback:

- **GitHub Issues:** Report bugs, request features, and discuss changes on our GitHub Issues page.
- **Twitter:** Follow us on Twitter for the latest updates and announcements.
- **Instagram:** Follow us on Instagram for behind-the-scenes content.
Expand All @@ -95,4 +94,4 @@ ScribbleLabApp is licensed under the MIT License. You are free to use, modify, a
For support or further inquiries, please contact us via email at:
**[email protected]**

Thank you for using ScribbleLabApp! We appreciate your contributions and feedback.
Thank you for using ScribbleLabApp! We appreciate your contributions and feedback.
8 changes: 4 additions & 4 deletions next.config.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import nextra from 'nextra'
import nextra from 'nextra';

const withNextra = nextra({
theme: 'nextra-theme-docs',
themeConfig: './theme.config.tsx',
latex: true,
search: {
codeblocks: true
codeblocks: true,
},
})
});

export default withNextra({
reactStrictMode: true,
})
});
Loading

0 comments on commit 64b2e53

Please sign in to comment.