From 64b2e538a07b966a32d731a2124873bf961a97e0 Mon Sep 17 00:00:00 2001 From: N3v1 Date: Mon, 25 Nov 2024 10:58:00 +0100 Subject: [PATCH] (chore): Format pages --- .github/ISSUE_TEMPLATE/a11y.yml | 6 +- .github/ISSUE_TEMPLATE/bug_report.yml | 10 +- .github/ISSUE_TEMPLATE/config.yml | 6 +- .github/ISSUE_TEMPLATE/page_request.yml | 6 +- .github/PULL_REQUEST_TEMPLATE.md | 8 +- .github/dependabot.yml | 6 +- .prettierignore | 3 +- CONTRIBUTING.md | 42 +-- LICENSE.md | 2 +- README.md | 51 ++- next.config.ts | 8 +- src/components/ui/footer.tsx | 300 +++++++++--------- src/pages/404.mdx | 60 ++-- src/pages/_meta.ts | 12 +- src/pages/community/_meta.ts | 6 +- src/pages/community/community.mdx | 11 +- src/pages/community/support.mdx | 11 +- src/pages/contributing/_meta.ts | 8 +- src/pages/contributing/codingstyle.mdx | 11 +- src/pages/contributing/documentation.mdx | 103 +++--- src/pages/contributing/index.mdx | 47 +-- src/pages/devresources/_meta.ts | 4 +- src/pages/getting_started/_meta.ts | 8 +- src/pages/getting_started/installation.mdx | 11 +- src/pages/getting_started/overview.mdx | 11 +- src/pages/getting_started/quickstart.mdx | 11 +- src/pages/guides/_meta.ts | 4 +- src/pages/index.mdx | 13 +- src/pages/legal/_meta.ts | 6 +- src/pages/legal/legal.mdx | 11 +- src/pages/legal/license.mdx | 11 +- src/pages/news/_meta.ts | 6 +- src/pages/news/changes/_meta.ts | 4 +- src/pages/news/changes/index.mdx | 2 +- src/pages/news/releases/_meta.ts | 4 +- src/pages/news/releases/index.mdx | 2 +- src/pages/security/_meta.ts | 4 +- src/pages/security/overview.mdx | 11 +- src/pages/troubleshooting/_meta.ts | 6 +- src/pages/troubleshooting/faq.mdx | 11 +- src/pages/troubleshooting/troubleshooting.mdx | 11 +- src/styles/globals.css | 2 +- theme.config.tsx | 33 +- 43 files changed, 470 insertions(+), 433 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/a11y.yml b/.github/ISSUE_TEMPLATE/a11y.yml index 9d1faa7..0ec6b4d 100644 --- a/.github/ISSUE_TEMPLATE/a11y.yml +++ b/.github/ISSUE_TEMPLATE/a11y.yml @@ -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 @@ -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 \ No newline at end of file + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 5791dd1..bd09cde 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 @@ -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 \ No newline at end of file + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ef6941e..1497e88 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 \ No newline at end of file + - name: Frequently Asked Questions (FAQ) + url: https://github.com/ScribbleLabApp/docs/tree/main + about: Find answers to common questions diff --git a/.github/ISSUE_TEMPLATE/page_request.yml b/.github/ISSUE_TEMPLATE/page_request.yml index b2e82c1..8708617 100644 --- a/.github/ISSUE_TEMPLATE/page_request.yml +++ b/.github/ISSUE_TEMPLATE/page_request.yml @@ -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 @@ -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 \ No newline at end of file + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e56cfdb..8a64723 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -29,6 +29,7 @@ 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. @@ -36,6 +37,7 @@ Describe the steps you took to verify that your changes are accurate and render - [ ] 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). @@ -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. \ No newline at end of file + +If there’s anything else that you think the reviewer should know or any additional context you’d like to provide, include it here. diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 42adb44..301e978 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,7 +5,7 @@ version: 2 updates: - - package-ecosystem: "npm" - directory: "/" + - package-ecosystem: 'npm' + directory: '/' schedule: - interval: "weekly" + interval: 'weekly' diff --git a/.prettierignore b/.prettierignore index 8b0eda6..a0387e5 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,4 +1,5 @@ node_modules/ .next/ out/ -public/ \ No newline at end of file +public/ +src/pages/contributing/documentation.mdx \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 475edc2..24f51a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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). @@ -48,13 +49,13 @@ 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! @@ -62,11 +63,11 @@ While we review all suggestions, not every idea will fit within our project’s 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. @@ -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 ``` @@ -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. @@ -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](). - \ No newline at end of file + diff --git a/LICENSE.md b/LICENSE.md index 2f7b01f..5197138 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -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. \ No newline at end of file +SOFTWARE. diff --git a/README.md b/README.md index 0cdf039..7f4d046 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 @@ -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. @@ -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. @@ -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: **support@scribblelabapp.com** -Thank you for using ScribbleLabApp! We appreciate your contributions and feedback. \ No newline at end of file +Thank you for using ScribbleLabApp! We appreciate your contributions and feedback. diff --git a/next.config.ts b/next.config.ts index 4f12226..4fccad8 100644 --- a/next.config.ts +++ b/next.config.ts @@ -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, -}) \ No newline at end of file +}); diff --git a/src/components/ui/footer.tsx b/src/components/ui/footer.tsx index c58996a..ba54095 100644 --- a/src/components/ui/footer.tsx +++ b/src/components/ui/footer.tsx @@ -1,151 +1,163 @@ import Link from 'next/link'; import { - FaGithub, - FaInstagram, - FaYoutube, - FaTwitter, - FaTiktok, - FaLinkedin, - FaDiscord, - } from 'react-icons/fa'; + FaGithub, + FaInstagram, + FaYoutube, + FaTwitter, + FaTiktok, + FaLinkedin, + FaDiscord, +} from 'react-icons/fa'; - export function Footer() { - const quickLinks = [ - { - category: 'Company', - links: [ - { name: 'About Us', href: '/about' }, - { name: 'Press & Media', href: '/press' }, - { name: 'Blog', href: '/blog' }, - { name: 'Contact Us', href: '/contact' }, - ], - }, - { - category: 'Resources', - links: [ - { name: 'Documentation', href: '/documentation' }, - { name: 'API Reference', href: '/api-reference' }, - { name: 'FAQs', href: '/faqs' }, - { name: 'Accessibility', href: '/accessibility' }, - ], - }, - { - category: 'Community', - links: [ - { name: 'Discord', href: '/discord' }, - { name: 'Forums', href: '/forums' }, - { name: 'Open Source', href: '/opensource' }, - ], - }, - { - category: 'Products', - links: [ - { name: 'ScribbleLab', href: '/products/scribblelab' }, - { name: 'ScribbleLab Pro', href: '/products/scribblelab-pro' }, - { name: 'ScribbleLab for Teams', href: '/products/teams' }, - { name: 'Compare Plans', href: '/products/compare-plans' }, - { - name: 'Get Started with ScribbleLab', - href: '/products/get-started', - }, - ], - }, - { - category: 'Support', - links: [ - { name: 'Help Center', href: '/help-center' }, - { name: 'Troubleshooting', href: '/troubleshooting' }, - { name: 'Report a Bug', href: '/report-bug' }, - { name: 'Feature Requests', href: '/feature-requests' }, - ], - }, - { - category: 'Legal', - links: [ - { name: 'Terms of Use', href: '/legal/terms' }, - { name: 'Privacy Policy', href: '/legal/privacy' }, - { name: 'Cookie Policy', href: '/legal/cookie-policy' }, - { name: 'Licensing', href: '/legal/licensing' }, - { name: 'Security', href: '/legal/security' }, - ], - }, - { - category: 'Showcase', - links: [ - { - name: 'Customer Stories', - href: '/showcase/customer-stories', - }, - { name: 'Case Studies', href: '/showcase/case-studies' }, - { name: 'Featured Projects', href: '/showcase/projects' }, - { name: 'Design Gallery', href: '/showcase/design-gallery' }, - ], - }, - ]; - - return ( - + ); +} diff --git a/src/pages/404.mdx b/src/pages/404.mdx index 0db7dce..be9b3ff 100644 --- a/src/pages/404.mdx +++ b/src/pages/404.mdx @@ -1,40 +1,40 @@ import { NotFoundPage } from 'nextra-theme-docs'; import Link from 'next/link'; -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; +import { Cards } from 'nextra/components'; +import { FaHouseChimney, FaBookBookmark, FaBug } from 'react-icons/fa6'; +import { HiWrenchScrewdriver } from 'react-icons/hi2'; # 404: Page Not Found -Oops! It seems you've wandered off the map. The page you're looking for might have been moved, renamed, or doesn't exist. -But don't worry, we've got you covered! Here are some helpful links to get back on track: + Oops! It seems you've wandered off the map. The page you're looking for might + have been moved, renamed, or doesn't exist. But don't worry, we've got you + covered! Here are some helpful links to get back on track: -
- - - - - - - - - - - - +
+ + } title="Go to Homepage" href="/" /> + } + title="Browse Documentation" + href="/" + /> + } + title="Visit Support Center" + href="/" + /> + } + title="Report an Issue" + href="https://github.com/ScribbleLabApp/docs/issues/new" + /> +
-β€” The ScribbleLabApp Team πŸ’‘ - - \ No newline at end of file +
+ β€” The ScribbleLabApp Team πŸ’‘ + +
diff --git a/src/pages/_meta.ts b/src/pages/_meta.ts index b9adb42..03bdf4f 100644 --- a/src/pages/_meta.ts +++ b/src/pages/_meta.ts @@ -6,16 +6,18 @@ export default { community: 'Community & Support', news: 'Changelog & Release Notes', troubleshooting: 'Troubleshooting & FAQ', - contributing: "Contributing", + contributing: 'Contributing', security: 'Security', legal: 'Legal & License', 404: { type: 'page', theme: { timestamp: false, - typesetting: 'article' - } + typesetting: 'article', + }, }, -} +}; -{/* Community & Support */} \ No newline at end of file +{ + /* Community & Support */ +} diff --git a/src/pages/community/_meta.ts b/src/pages/community/_meta.ts index bd2df1b..b261f16 100644 --- a/src/pages/community/_meta.ts +++ b/src/pages/community/_meta.ts @@ -1,4 +1,4 @@ export default { - community: 'Community', - support: 'ScribbleLab Support' -} \ No newline at end of file + community: 'Community', + support: 'ScribbleLab Support', +}; diff --git a/src/pages/community/community.mdx b/src/pages/community/community.mdx index f5dd925..a347ed6 100644 --- a/src/pages/community/community.mdx +++ b/src/pages/community/community.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # ScribbleLabApp Community @@ -7,7 +7,8 @@ import { Callout } from 'nextra/components' This documentation page hasn't been created yet. You can be the first to contribute! - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/pages/community/support.mdx b/src/pages/community/support.mdx index 1f2cc05..7145b05 100644 --- a/src/pages/community/support.mdx +++ b/src/pages/community/support.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # ScribbleLabApp Support @@ -7,7 +7,8 @@ import { Callout } from 'nextra/components' This documentation page hasn't been created yet. You can be the first to contribute! - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/pages/contributing/_meta.ts b/src/pages/contributing/_meta.ts index b49f2b3..580dd86 100644 --- a/src/pages/contributing/_meta.ts +++ b/src/pages/contributing/_meta.ts @@ -1,5 +1,5 @@ export default { - index: "Contribution Guidelines", - documentation: "Adding new documentation", - codingstyle: "Coding Style Guidelines" -} \ No newline at end of file + index: 'Contribution Guidelines', + documentation: 'Adding new documentation', + codingstyle: 'Coding Style Guidelines', +}; diff --git a/src/pages/contributing/codingstyle.mdx b/src/pages/contributing/codingstyle.mdx index 9412b93..f820010 100644 --- a/src/pages/contributing/codingstyle.mdx +++ b/src/pages/contributing/codingstyle.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # ScribbleLabApp Coding Style Guidelines @@ -7,7 +7,8 @@ import { Callout } from 'nextra/components' This documentation page hasn't been created yet. You can be the first to contribute! - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/pages/contributing/documentation.mdx b/src/pages/contributing/documentation.mdx index 52cbf88..2679a42 100644 --- a/src/pages/contributing/documentation.mdx +++ b/src/pages/contributing/documentation.mdx @@ -1,9 +1,9 @@ -import { Callout } from 'nextra/components' -import { Steps } from 'nextra/components' +import { Callout } from 'nextra/components'; +import { Steps } from 'nextra/components'; # Adding new Documentation -This guide walks you through the steps required to add new pages or topics to your Nextra documentation site. +This guide walks you through the steps required to add new pages or topics to your Nextra documentation site. Whether you're a maintainer or a contributor, following these steps will help you expand the documentation structure efficiently. ### Prerequisites @@ -11,9 +11,9 @@ Whether you're a maintainer or a contributor, following these steps will help yo 1. **Node.js and npm:** Ensure that Node.js (>= v22.0.0) and npm are installed on your system. 2. **Nextra Installed:** Confirm that your site uses Nextra. If not, install it using: - ```bash npm2yarn - npm i nextra nextra-theme-docs - ``` + ```bash npm2yarn copy + npm i nextra nextra-theme-docs + ``` 3. **Git Access:** Make sure you have write access to the repository or the ability to fork and submit pull requests. @@ -25,12 +25,12 @@ Nextra organizes pages in the pages directory at the root of your project. This ```md pages/ - β”œβ”€β”€ index.md // Home page - β”œβ”€β”€ guide/ - β”‚ β”œβ”€β”€ installation.md // /guide/installation - β”‚ └── setup.md // /guide/setup - └── api/ - └── reference.md // /api/reference +β”œβ”€β”€ index.md // Home page +β”œβ”€β”€ guide/ +β”‚ β”œβ”€β”€ installation.md // /guide/installation +β”‚ └── setup.md // /guide/setup +└── api/ +└── reference.md // /api/reference ``` ### Create a Markdown React File @@ -41,7 +41,7 @@ To add a new page: 2. Inside the directory, create a `.mdx` file with a descriptive filename, e.g., `introduction.mdx`. 3. Write your documentation using MDX, which combines Markdown and React for flexible content creation. Follow this structure for a consistent style: -```mdx filename="introduction.mdx" +````mdx filename="introduction.mdx" # Introduction to New Topic Welcome to the documentation for **New Topic**. This page provides a detailed overview of the topic, its purpose, and how it can be utilized effectively. @@ -51,11 +51,13 @@ Welcome to the documentation for **New Topic**. This page provides a detailed ov Explain the core concept of the topic. Use clear and concise language. Include definitions, background information, and any relevant context. For example: + > "New Topic" is a feature/module/tool designed to simplify workflows by providing XYZ capabilities. ## Key Features of New Topic Highlight the main features, benefits, or applications: + - **Feature 1:** Brief description of the feature. - **Feature 2:** Highlight its value. - **Feature 3:** How it helps users. @@ -65,6 +67,7 @@ Highlight the main features, benefits, or applications: Provide step-by-step guidance or examples on how to use the feature/module/tool: ### Example 1: Basic Usage + ```javascript // Example of how to implement or use the feature import { NewTopic } from 'your-library'; @@ -72,6 +75,7 @@ import { NewTopic } from 'your-library'; const demo = NewTopic({ key: 'value' }); console.log(demo); ``` +```` #### Content Writing Tips @@ -83,7 +87,7 @@ console.log(demo); ### Adding Page Sidebar Metadata -In Nextra, sidebar metadata helps organize your pages and topics in the navigation menu. This is managed using `_meta.ts` files +In Nextra, sidebar metadata helps organize your pages and topics in the navigation menu. This is managed using `_meta.ts` files within directories or directly via `theme.config.ts` (not recommended). #### Adding Metadata to `_meta.ts` @@ -97,23 +101,22 @@ Each folder containing pages should include a `_meta.ts` file. For example: ```md pages/ - β”œβ”€β”€ guide/ - β”‚ β”œβ”€β”€ _meta.ts - β”‚ β”œβ”€β”€ installation.mdx - β”‚ └── setup.mdx +β”œβ”€β”€ guide/ +β”‚ β”œβ”€β”€ \_meta.ts +β”‚ β”œβ”€β”€ installation.mdx +β”‚ └── setup.mdx ``` #### Update the `_meta.ts` File -Add an entry for your new page. The structure of `_meta.ts` is a simple JavaScript object where the key is +Add an entry for your new page. The structure of `_meta.ts` is a simple JavaScript object where the key is the page's filename (excluding the `.mdx` extension), and the value is its display name. -```mdx filename="_meta.ts" -// pages/guide/_meta.ts +```mdx filename="pages/guide/_meta.ts" {4} export default { - installation: 'Installation Guide', - setup: 'Setup Instructions', - newtopic: 'New Topic Documentation', // Add your new page here + installation: 'Installation Guide', + setup: 'Setup Instructions', + newtopic: 'New Topic Documentation', }; ``` @@ -121,16 +124,16 @@ export default { If your new topic is part of a subdirectory, link its `_meta.ts` file within the parent directory's `_meta.ts` file. -```mdx filename="_meta.ts" +```mdx filename="pages/_meta.ts" {3-5} export default { - index: 'Home', - guide: { - _meta: import('./guide/_meta'), // Reference the guide metadata - 'new-section': 'New Section Title', // Optional additional pages - }, - api: 'API Reference', + index: 'Home', + guide: { + 'new-section': 'New Section Title', + }, + api: 'API Reference', }; ``` + ### Adding a New Topic (Parent Directory) @@ -140,7 +143,7 @@ If your new topic doesn't fit within existing sections, create a new parent dire #### Create the Directory -For instance, to add a *β€œTutorials”* section: +For instance, to add a _β€œTutorials”_ section: ```bash mkdir -p pages/tutorials @@ -150,10 +153,10 @@ mkdir -p pages/tutorials Create a `_meta.ts` file to define the sidebar metadata for this section. -```mdx filename="_meta.ts" +```mdx filename="pages/tutorial/_meta.ts" export default { - 'getting-started': 'Getting Started', - 'advanced-tutorials': 'Advanced Tutorials', + 'getting-started': 'Getting Started', + 'advanced-tutorials': 'Advanced Tutorials', }; ``` @@ -161,22 +164,21 @@ export default { Update the root `_meta.ts` file to include the new section. -```mdx filename="_meta.ts" +```mdx filename="pages/_meta.ts" {6-8} export default { - index: 'Home', - guide: { - _meta: import('./guide/_meta'), - }, - tutorials: { - _meta: import('./tutorials/_meta'), // Add reference to the new section - }, - api: 'API Reference', + index: 'Home', + guide: { + _meta: import('./guide/_meta'), + }, + tutorials: { + _meta: import('./tutorials/_meta'), + }, + api: 'API Reference', }; ``` - ### Testing Your Changes After updating or adding new pages and metadata, test your changes locally to ensure they appear as expected. @@ -186,7 +188,7 @@ After updating or adding new pages and metadata, test your changes locally to en Start the Nextra development server to preview the changes: -```bash +```bash copy npm run dev ``` @@ -204,7 +206,7 @@ npm run dev Use linting tools to catch formatting or syntax errors: -```bash +```bash copy npm run lint npm run format ``` @@ -214,15 +216,16 @@ npm run format Formatting requires Prettier to be installed. If you don't have it, run: - ```bash npm2yarn + ```bash npm2yarn copy npm install --save-dev --save-exact prettier ``` To see if Prettier is installed locally, run: - ```bash + ```bash copy npx prettier --version ``` + - \ No newline at end of file + diff --git a/src/pages/contributing/index.mdx b/src/pages/contributing/index.mdx index c08585f..c06d88f 100644 --- a/src/pages/contributing/index.mdx +++ b/src/pages/contributing/index.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # Contributing Guidelines for ScribbleLabApp Documentations @@ -8,15 +8,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 @@ -26,6 +26,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). @@ -47,12 +48,13 @@ 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: - - A clear description of the feature and its purpose. +2. Use the feature request template to provide: + + - 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! @@ -60,14 +62,14 @@ While we review all suggestions, not every idea will fit within our project's sc 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). - All contributions are licensed under ScribbleLab's project license. + All contributions are licensed under ScribbleLab's project license. ## Coding Style @@ -84,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 ``` @@ -102,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. @@ -122,4 +125,4 @@ We use [Nextra](https://nextra.vercel.app/) and [Next.js](https://nextjs.org/) f 3. Ensure your documentation follows the structure and style of existing documents. 4. Submit a pull request with your changes. -For more detailed instructions, refer to our [documentation guide](). \ No newline at end of file +For more detailed instructions, refer to our [documentation guide](). diff --git a/src/pages/devresources/_meta.ts b/src/pages/devresources/_meta.ts index ff2dbce..ff8b4c5 100644 --- a/src/pages/devresources/_meta.ts +++ b/src/pages/devresources/_meta.ts @@ -1,3 +1 @@ -export default { - -} \ No newline at end of file +export default {}; diff --git a/src/pages/getting_started/_meta.ts b/src/pages/getting_started/_meta.ts index e033f1e..e3096af 100644 --- a/src/pages/getting_started/_meta.ts +++ b/src/pages/getting_started/_meta.ts @@ -1,5 +1,5 @@ export default { - overview: 'Overview', - installation: 'Installation', - quickstart: 'Quickstart', -} \ No newline at end of file + overview: 'Overview', + installation: 'Installation', + quickstart: 'Quickstart', +}; diff --git a/src/pages/getting_started/installation.mdx b/src/pages/getting_started/installation.mdx index 23435cb..9178ecb 100644 --- a/src/pages/getting_started/installation.mdx +++ b/src/pages/getting_started/installation.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # Installation @@ -7,7 +7,8 @@ import { Callout } from 'nextra/components' This documentation page hasn't been created yet. You can be the first to contribute! - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/pages/getting_started/overview.mdx b/src/pages/getting_started/overview.mdx index bd0692f..0776d30 100644 --- a/src/pages/getting_started/overview.mdx +++ b/src/pages/getting_started/overview.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # Overview @@ -7,7 +7,8 @@ import { Callout } from 'nextra/components' This documentation page hasn't been created yet. You can be the first to contribute! - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/pages/getting_started/quickstart.mdx b/src/pages/getting_started/quickstart.mdx index 31f8112..4042c79 100644 --- a/src/pages/getting_started/quickstart.mdx +++ b/src/pages/getting_started/quickstart.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # Quick Start @@ -7,7 +7,8 @@ import { Callout } from 'nextra/components' This documentation page hasn't been created yet. You can be the first to contribute! - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/pages/guides/_meta.ts b/src/pages/guides/_meta.ts index ff2dbce..ff8b4c5 100644 --- a/src/pages/guides/_meta.ts +++ b/src/pages/guides/_meta.ts @@ -1,3 +1 @@ -export default { - -} \ No newline at end of file +export default {}; diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 5f17d23..062e5db 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -1,15 +1,16 @@ # Welcome to ScribbleLabApp Docs -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; Welcome to the ScribbleLabApp Documentation! This resource is your go-to guide for exploring, integrating, and mastering all the features ScribbleLabApp has to offer. Our product documentation is a **work in progress**, and we're **constantly evolving** to bring you the **best support** and information possible. If you notice gaps, have suggestions, or want to get involved, your **contributions are greatly appreciated**! ScribbleLab is a **community-driven project**, - and we thrive on your **insights and expertise**. + and we thrive on your **insights and expertise**. - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/pages/legal/_meta.ts b/src/pages/legal/_meta.ts index f83d470..5a6f28e 100644 --- a/src/pages/legal/_meta.ts +++ b/src/pages/legal/_meta.ts @@ -1,4 +1,4 @@ export default { - legal: 'Legal', - license: 'License', -} \ No newline at end of file + legal: 'Legal', + license: 'License', +}; diff --git a/src/pages/legal/legal.mdx b/src/pages/legal/legal.mdx index 83e11ed..1b4a4ac 100644 --- a/src/pages/legal/legal.mdx +++ b/src/pages/legal/legal.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # Legal @@ -7,7 +7,8 @@ import { Callout } from 'nextra/components' This documentation page hasn't been created yet. You can be the first to contribute! - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/pages/legal/license.mdx b/src/pages/legal/license.mdx index 5b6eeec..d8c06f9 100644 --- a/src/pages/legal/license.mdx +++ b/src/pages/legal/license.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # Open Source License @@ -7,7 +7,8 @@ import { Callout } from 'nextra/components' This documentation page hasn't been created yet. You can be the first to contribute! - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/pages/news/_meta.ts b/src/pages/news/_meta.ts index 26b4d58..efdfdf2 100644 --- a/src/pages/news/_meta.ts +++ b/src/pages/news/_meta.ts @@ -1,4 +1,4 @@ export default { - changes: 'Changelogs', - releases: 'Release Notes', -} \ No newline at end of file + changes: 'Changelogs', + releases: 'Release Notes', +}; diff --git a/src/pages/news/changes/_meta.ts b/src/pages/news/changes/_meta.ts index ad0df5e..d732520 100644 --- a/src/pages/news/changes/_meta.ts +++ b/src/pages/news/changes/_meta.ts @@ -1,3 +1,3 @@ export default { - index: 'Placeholder' -} \ No newline at end of file + index: 'Placeholder', +}; diff --git a/src/pages/news/changes/index.mdx b/src/pages/news/changes/index.mdx index 6e22470..bf42b65 100644 --- a/src/pages/news/changes/index.mdx +++ b/src/pages/news/changes/index.mdx @@ -1 +1 @@ -# Changelog Placeholder \ No newline at end of file +# Changelog Placeholder diff --git a/src/pages/news/releases/_meta.ts b/src/pages/news/releases/_meta.ts index ad0df5e..d732520 100644 --- a/src/pages/news/releases/_meta.ts +++ b/src/pages/news/releases/_meta.ts @@ -1,3 +1,3 @@ export default { - index: 'Placeholder' -} \ No newline at end of file + index: 'Placeholder', +}; diff --git a/src/pages/news/releases/index.mdx b/src/pages/news/releases/index.mdx index d765251..e4b576e 100644 --- a/src/pages/news/releases/index.mdx +++ b/src/pages/news/releases/index.mdx @@ -1 +1 @@ -# Release Notes Placeholder \ No newline at end of file +# Release Notes Placeholder diff --git a/src/pages/security/_meta.ts b/src/pages/security/_meta.ts index 82ff115..fbc24b2 100644 --- a/src/pages/security/_meta.ts +++ b/src/pages/security/_meta.ts @@ -1,3 +1,3 @@ export default { - overview: 'Overview', -} \ No newline at end of file + overview: 'Overview', +}; diff --git a/src/pages/security/overview.mdx b/src/pages/security/overview.mdx index a7f5504..181339a 100644 --- a/src/pages/security/overview.mdx +++ b/src/pages/security/overview.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # Security @@ -7,7 +7,8 @@ import { Callout } from 'nextra/components' This documentation page hasn't been created yet. You can be the first to contribute! - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/pages/troubleshooting/_meta.ts b/src/pages/troubleshooting/_meta.ts index a8d91bf..78c7176 100644 --- a/src/pages/troubleshooting/_meta.ts +++ b/src/pages/troubleshooting/_meta.ts @@ -1,4 +1,4 @@ export default { - faq: 'FAQ', - troubleshooting: 'Troubleshooting Guides', -} \ No newline at end of file + faq: 'FAQ', + troubleshooting: 'Troubleshooting Guides', +}; diff --git a/src/pages/troubleshooting/faq.mdx b/src/pages/troubleshooting/faq.mdx index 9a7175a..dc23e5b 100644 --- a/src/pages/troubleshooting/faq.mdx +++ b/src/pages/troubleshooting/faq.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # Frequently Asked Questions (FAQ) @@ -7,7 +7,8 @@ import { Callout } from 'nextra/components' This documentation page hasn't been created yet. You can be the first to contribute! - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/pages/troubleshooting/troubleshooting.mdx b/src/pages/troubleshooting/troubleshooting.mdx index f587099..9836e47 100644 --- a/src/pages/troubleshooting/troubleshooting.mdx +++ b/src/pages/troubleshooting/troubleshooting.mdx @@ -1,4 +1,4 @@ -import { Callout } from 'nextra/components' +import { Callout } from 'nextra/components'; # Troubleshooting Guide @@ -7,7 +7,8 @@ import { Callout } from 'nextra/components' This documentation page hasn't been created yet. You can be the first to contribute! - **How to Contribute?** - Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. - Whether you're a developer, designer, or user with feedback, **every contribution counts**! - \ No newline at end of file + **How to Contribute?** + Head over to our [GitHub Repository](https://github.com/ScribbleLabApp/docs) to find contribution guidelines, open issues, and ideas that need your help. + Whether you're a developer, designer, or user with feedback, **every contribution counts**! + + diff --git a/src/styles/globals.css b/src/styles/globals.css index a54c4ab..8108f26 100644 --- a/src/styles/globals.css +++ b/src/styles/globals.css @@ -4,4 +4,4 @@ body { font-family: Arial, Helvetica, sans-serif; -} \ No newline at end of file +} diff --git a/theme.config.tsx b/theme.config.tsx index 9f98f1d..e760302 100644 --- a/theme.config.tsx +++ b/theme.config.tsx @@ -1,5 +1,5 @@ -import { useConfig } from 'nextra-theme-docs' -import { Footer } from '@/components/ui/footer' +import { useConfig } from 'nextra-theme-docs'; +import { Footer } from '@/components/ui/footer'; /* eslint sort-keys: error */ /** @@ -14,31 +14,32 @@ export default { { locale: 'it-it', name: 'Italiano' }, ], banner: { - content: 'πŸš€ Join Us in Improving the Docs: Your Contributions Can Make a Difference!', + content: + 'πŸš€ Join Us in Improving the Docs: Your Contributions Can Make a Difference!', key: 'Product Docs', - dismissible: true + dismissible: true, }, chat: { - link: 'https://discord.gg/Y5mUJbNC8h' + link: 'https://discord.gg/Y5mUJbNC8h', }, - docsRepositoryBase: - 'https://github.com/ScribbleLabApp/docs/tree/main', + docsRepositoryBase: 'https://github.com/ScribbleLabApp/docs/tree/main', editLink: { - content: 'Edit this page on GitHub' + content: 'Edit this page on GitHub', }, project: { - link: 'https://github.com/ScribbleLabApp/docs' + link: 'https://github.com/ScribbleLabApp/docs', }, footer: { component: