NodeByte Assets Repository

Welcome to the NodeByte Assets repository! This repository contains markdown files for our knowledge base, legal documents, and other assets. We welcome contributions from the community to help improve our documentation and resources.

Table of Contents

• Introduction
• Getting Started
• Contributing
• Folder Structure
• Markdown Guidelines
• License

Introduction

This repository contains markdown files for various sections of our knowledge base, legal documents, and other assets. By contributing to this repository, you can help improve the quality and accuracy of our documentation.

Getting Started

To get started with contributing to this repository, follow these steps:

1. Fork the Repository: Click the "Fork" button at the top right of this page to create a copy of this repository in your GitHub account.
2. Clone the Repository: Clone the forked repository to your local machine using the following command:

   git clone https://github.com/your-username/assets.git

3. Navigate to the Repository: Change into the repository directory:

   cd assets

Contributing

We welcome contributions to this repository! To contribute, follow these steps:

1. Create a Branch: Create a new branch for your changes:

   git checkout -b my-new-branch

2. Make Changes: Make your changes to the markdown files in the repository.
3. Commit Changes: Commit your changes with a descriptive commit message:

   git add .
   git commit -m "Description of my changes"

4. Push Changes: Push your changes to your forked repository:

   git push origin my-new-branch

5. Create a Pull Request: Open a pull request from your forked repository to the main repository. Provide a clear description of your changes and why they should be merged.

Folder Structure

The repository is organized into the following folders:

• markdown/kb: Contains markdown files for the knowledge base.
• markdown/legal: Contains markdown files for legal documents (e.g., privacy policy, terms of service).
• markdown/kb/articles.json: Contains all the file information for the knowledge base files.

Markdown Guidelines

When contributing markdown files, please follow these guidelines:

• Headings: Use appropriate heading levels (#, ##, ###, etc.) to organize content.
• Links: Use descriptive link text and ensure links are valid.
• Lists: Use ordered (1., 2., 3.) or unordered (-, *, +) lists as needed.
• Code Blocks: Use triple backticks () for code blocks and specify the language (e.g., ` javascript `).
• Images: Use the following syntax to include images:

  ![Alt text](path/to/image.png)

Knowledge Base Articles

All of our knowledge base articles can be found at markdown/kb, when creating a new article please make sure to add its necessary data in the articles.json file. The layout provided in this json file should be followed at all times or issues will arise with the website!

---

Thank you for contributing to the NodeByte Assets repository! If you have any questions or need assistance, feel free to open an issue or contact us.