Merge pull request #2785 from build-5/master-to-dev

.github/workflows/docs-validate-build.yml

@@ -10,14 +10,13 @@ concurrency:
 jobs:
   build:
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./docs
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
+      - name: Build whole project
+        run: npm run build && cd docs
       - name: Allow modern Yarn
         run: corepack enable
       - name: Install dependencies

README.md

@@ -1,38 +1,199 @@
+<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
+<a name="readme-top"></a>
+<!--
+*** Thanks for checking out the Best-README-Template. If you have a suggestion
+*** that would make this better, please fork the repo and create a pull request
+*** or simply open an issue with the tag "enhancement".
+*** Don't forget to give the project a star!
+*** Thanks again! Now go create something AMAZING! :D
+-->
+
+
+
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
+
+
+
 <!-- PROJECT LOGO -->
 <br />
 <div align="center">
-    <img src="docs/static/img/logo.svg" alt="BUILD.5 logo">
-    <h3 align="center">BUILD.5 Core</h3>
-    <p align="center">
-        Your Enterprise ready web3 plug & play platform
-        <br />
-        <a href="https://developer.build5.com/"><strong>Explore the docs »</strong></a>
-        <br />
-        <br />
-        <a href="https://github.com/build-5/core/issues/new?template=bug_report.md">Report Bug</a>
-        ·
-        <a href="https://github.com/build-5/core/issues/new?template=feature_request.md">Request Feature</a>
-    </p>
+  <a href="https://github.com/build-5/core">
+    <img src="docs/static/img/logo.svg" alt="BUILD.5 logo" width="80" height="80">
+  </a>
+
+<h3 align="center">BUILD.5 Core</h3>
+
+  <p align="center">
+    Your Enterprise ready web3 plug & play platform
+    <br />
+    <a href="https://developer.build5.com/"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/build-5/core/issues/new?template=bug_report.md">Report Bug</a>
+    ·
+    <a href="https://github.com/build-5/core/issues/new?template=feature_request.md">Request Feature</a>
+  </p>
 </div>
 
-# Framework
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details>
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+Build.5 is your Enterprise ready web3 plug & play platform. This repo contains the back-end based on [serverless functions](./packages/functions/) and our easy to use [SDK](./packages/sdk/) for third parties.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+### Built With
+
+* [![Typescript][Typescript]][Typescript-url]
+* [![Firestore][Firestore]][Firestore-url]
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+To build the project locally, follow these simple steps. If you are interested in using the SDK to interact with our services, please refer to the [SDK documentation](https://developer.build5.com/).
+
+### Prerequisites
+
+Make sure you have the following installed:
+
+* npm
+* node >= 20
+* modern yarn (optional, for running the docs locally)
+
+
+
+### Installation
+
+1. Clone the repo
+   ```sh
+   git clone https://github.com/build-5/core.git
+   ```
+2. Install NPM packages
+   ```sh
+   npm install
+   ```
+3. Build the packages
+   ```sh
+   yarn build
+   ```
+
+For running the docs locally, please refer to the documentation [README](./docs/README.md).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
+The best way to get started with the SDK and interacting with Build.5 is [installing the SDK](https://www.npmjs.com/package/@build-5/sdk) and have a look at our [documentation](https://developer.build5.com).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+For more information on how to contribute, please read [CONTRIBUTING.md](./CONTRIBUTING.md)
+
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/build-5/core/pulls)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the Apache License. See `LICENSE` for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-The platform is designed to eventually transition away from all centralized services. It has been build using modern development tools and primarely using Typescript language.
 
-Back-end is written as serverless functions (see /packages/functions)
 
-Library for third parties is located under /packages/lib and /packages/interfaces
+<!-- CONTACT -->
+## Contact
 
-### /packages/functions
+Build.5 - [@build5tech](https://twitter.com/build5tech) - [email protected]
 
-- Typescript Functions
-- Firestore (Database)
-- Typescript
+Project Link: [https://build5.com](https://build5.com)
 
-# 🤝 Contributing
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/soonaverse/soonaverse/pulls)
 
-We welcome all contributions. Please read our [CONTRIBUTING.md](https://github.com/soonaverse/soonaverse/blob/master/CONTRIBUTING.md) first. You can submit any ideas as [pull requests](https://github.com/soonaverse/soonaverse/pulls) or as [GitHub issues](https://github.com/soonaverse/soonaverse/issues).
 
-Thank you for supporting us free open source licenses.
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/build-5/core.svg?style=for-the-badge
+[contributors-url]: https://github.com/build-5/core/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/build-5/core.svg?style=for-the-badge
+[forks-url]: https://github.com/build-5/core/network/members
+[stars-shield]: https://img.shields.io/github/stars/build-5/core.svg?style=for-the-badge
+[stars-url]: https://github.com/build-5/core/stargazers
+[issues-shield]: https://img.shields.io/github/issues/build-5/core.svg?style=for-the-badge
+[issues-url]: https://github.com/build-5/core/issues
+[license-shield]: https://img.shields.io/github/license/build-5/core.svg?style=for-the-badge
+[license-url]: https://github.com/build-5/core/blob/master/LICENSE
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://linkedin.com/company/build5/
+[Typescript]: https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white
+[Typescript-url]: https://www.typescriptlang.org/
+[Firestore]: https://img.shields.io/badge/Firebase-FFCA28?style=for-the-badge&logo=firebase&logoColor=black
+[Firestore-url]: https://firebase.google.com/

docs/.gitignore

@@ -4,6 +4,8 @@
 # Production
 /build
 /docs/search-*
+/docs/reference-api
+/docs/sdk
 
 # Generated files
 .docusaurus

docs/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

docs/README.md

@@ -1,12 +1,15 @@
 # Website
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
 
 ### Installation
 
 > [!NOTE]
 > The docs use modern [Yarn](https://yarnpkg.com). So don't forget to run `corepack enable` first if you don't have it already.
 
+> [!NOTE]
+> To use the docs you have to [build](../README.md) the packages first. 
+
 ```
 $ yarn
 ```

docs/docs/_admonitions/_deep_link.md

@@ -1,4 +1,4 @@
-:::warning OTR Request Deep Link
+:::info OTR Request Deep Link
 
 The SDK provides the helper functions `getFireflyDeepLink()` and `getBloomDeepLink()` to generate deep links for OTR requests.
 

docs/docs/getting-started.mdx

@@ -24,9 +24,9 @@ npm i @build-5/interfaces
 ## API
 
 There are REST APIs to simplify read and write operations. See following:
-- [GET](search-get) - Use this APIs to get any data from Build.5
-- [WSS](search-get) - Any [GET](search-get) can be requested as wss:// to receive web socket with real-time updates
-- [POST](search-post) - Use these APIs to post any requests to Build.5 (alternative to [OTR](search-otr))
+- [GET](reference-api) - Use this APIs to get any data from Build.5
+- [WSS](reference-api) - Any [GET](reference-api) can be requested as wss:// to receive web socket with real-time updates
+- [POST](reference-api) - Use these APIs to post any requests to Build.5 (alternative to [OTR](reference-api))
 
 :::info
 

docs/docs/on-tangle-request.md

@@ -8,7 +8,7 @@ tags:
 
 On tangle requests are a secure and transparent way to interact with build.5 products. They are a way to send a request to a build.5 backend over the Tangle. The backend will then execute the request. All interactions can be verified on the Tangle.
 
-OTR uses metadata to describe the request. The metadata is a JSON object. You can find the API reference for the metadata [here](search-otr), but we recommend using our [SDK](https://developer.build5.com/docs/getting_started#sdk).
+OTR uses metadata to describe the request. The metadata is a JSON object. You can find the API reference for the metadata [here](reference-api), but we recommend using our [SDK](https://developer.build5.com/docs/getting_started#sdk).
 
 ## Why OTR?
 

docs/docs/products/dao-management/member/how-to/create-member.md

@@ -7,7 +7,7 @@ tags:
 ---
 
 To create a member, you need to call `createMember`.
-`createMember` takes an object of type `Build5Request<`[`CreateMemberRequest`](../../../../search-post/interfaces/CreateMemberRequest.md)`>` as parameter.
+`createMember` takes an object of type `Build5Request<`[`CreateMemberRequest`](../../../../reference-api/interfaces/CreateMemberRequest.md)`>` as parameter.
 
 
 ```tsx file=../../../../../../packages/sdk/examples/member/create.ts#L7-L13

docs/docs/products/dao-management/member/how-to/update-member.md

@@ -12,7 +12,7 @@ To update a member, we first get the member with their ID, which, in this case,
 ```
 
 With the member, we can create a signature and update, for example, the name by calling `update` on `dataset(Dataset.MEMBER)` and passing the new name in the body.
-`update` takes an object of type `Build5Request<`[`MemberUpdateRequest`](../../../../search-post/interfaces/MemberUpdateRequest.md)`>` as parameter.
+`update` takes an object of type `Build5Request<`[`MemberUpdateRequest`](../../../../reference-api/interfaces/MemberUpdateRequest.md)`>` as parameter.
 
 ```tsx file=../../../../../../packages/sdk/examples/member/update.ts#L17-L30
 ```

docs/docs/products/dao-management/member/how-to/validate-address.md

@@ -2,7 +2,7 @@
 title: Validate Space Address
 ---
 
-To validate the address of a member, you must call `validateAddress` on `dataset(Dataset.MEMBER)`. `validateAddress` takes an object of type `Build5Request<`[`AddressValidationRequest`](../../../../search-post/interfaces/AddressValidationRequest.md)`>` as parameter.
+To validate the address of a member, you must call `validateAddress` on `dataset(Dataset.MEMBER)`. `validateAddress` takes an object of type `Build5Request<`[`AddressValidationRequest`](../../../../reference-api/interfaces/AddressValidationRequest.md)`>` as parameter.
 
 ```tsx file=../../../../../../packages/sdk/examples/member/validate_address.ts#L16-L30
 ```

docs/docs/products/dao-management/space/how-to/create-space.md

@@ -7,7 +7,7 @@ tags:
 ---
 
 To create a space, you must call `create` on `dataset(Dataset.SPACE)`. In the body, you can specify the name of the space.
-`create` takes an object of type `Build5Request<`[`SpaceCreateRequest`](../../../../search-post/interfaces/SpaceCreateRequest.md)`>` as parameter.
+`create` takes an object of type `Build5Request<`[`SpaceCreateRequest`](../../../../reference-api/interfaces/SpaceCreateRequest.md)`>` as parameter.
 
 :::info Create a Member first
 

docs/docs/products/dao-management/space/how-to/update-space.md

@@ -1,6 +1,6 @@
 ---
 title: Update Space
-keywords:
+tags:
   - how-to
   - update
   - space
@@ -18,7 +18,7 @@ You can only update Spaces where you are a Guardian
 :::
 
 With the space ID and Guardian member we can create a signature and update, for example, the name by calling `update` on `dataset(Dataset.SPACE)` and passing the new name in the body.
-`update` takes an object of type `Build5Request<`[`SpaceUpdateRequest`](../../../../search-post/interfaces/SpaceUpdateRequest.md)`>` as parameter.
+`update` takes an object of type `Build5Request<`[`SpaceUpdateRequest`](../../../../reference-api/interfaces/SpaceUpdateRequest.md)`>` as parameter.
 
 ```tsx file=../../../../../../packages/sdk/examples/space/update.ts#L19-L33
 ```

docs/docs/products/dao-management/space/how-to/validate-address.md

@@ -2,7 +2,7 @@
 title: Validate Space Address
 ---
 
-To validate the address of a space, you must call `validateAddress` on `dataset(Dataset.SPACE)`. `validateAddress` takes an object of type `Build5Request<`[`AddressValidationRequest`](../../../../search-post/interfaces/AddressValidationRequest.md)`>` as parameter in wich you can specify the name of the space.
+To validate the address of a space, you must call `validateAddress` on `dataset(Dataset.SPACE)`. `validateAddress` takes an object of type `Build5Request<`[`AddressValidationRequest`](../../../../reference-api/interfaces/AddressValidationRequest.md)`>` as parameter in wich you can specify the name of the space.
 
 ```tsx file=../../../../../../packages/sdk/examples/space/validate_address.ts#L19-L33
 ```