Website

You can access the documentation page here.

This website is built using Docusaurus, a modern static website generator.

Installation

$ cd docs
$ npm install

Local Development

$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Contributions

To contribute, please make a pull request.

---

🛠️ How to Create a Pull Request (PR)

1. Fork the Repository

   Click the "Fork" button at the top right of this repository to create your own copy.

2. Clone Your Fork

   In your terminal or Git client, clone your forked repo:

   git clone https://github.com/<your-username>/X20-Edge-UseCases.git
   cd X20-Edge-UseCases

3. Create a Branch

   Create a new branch for your changes:

   git checkout -b my-feature-name

4. Make Your Changes

   Edit files, add content, fix bugs etc.

   For how to structure documentation you can look at "docs/docs/iot-workshop/" Please test that you can build the documentation inside docs directory with:

   npm run build
   npm start

5. Commit Your Changes

   After making changes, stage and commit them:

   git add .
   git commit -m "Add feature or fix description"

6. Push to Your Fork

   Push your changes to your forked repository:

   git push origin my-feature-name

7. Open a Pull Request

   Go to your fork on GitHub, click "Compare & pull request", add a title and description explaining your changes, and click "Create pull request".