Merge pull request #185 from BibliothecaDAO/docs-content

docs and game links

README.md

@@ -8,61 +8,40 @@
 [![discord](https://img.shields.io/badge/join-bibliothecadao-black?logo=discord&logoColor=white)](https://discord.gg/realmsworld)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-![background](/docs/assets/images/bg.png)
+![background](/apps/docs/assets/images/bg.png)
 
-# Realms.World
+# Realms.World - The Hub for the AW
 
-## The portal to the Realms Autonomous World
+### Realms.World is the information and activity hub for the Realms Autonomous World.
 
-Realms.World is the information and activity hub for entrance to the Realms Autonomous World. It includes a comprehensive and interactive marketplace dedicated to the Loot and Realms ecosystem (both on Ethereum and Starknet), ecosystem functionality such as bridging, staking, and NFT minting, and information about the various games of the World. The client is built on Next.js 13, utilizing server and client components to achieve high performance and scalability.
+[Realms.World](https://realms.world) is the central hub for the Realms Autonomous World, offering a comprehensive marketplace NFTs on Ethereum and Starknet. Features include:
 
-#### Table of Contents
+- L1 Marketplace
+- L2 onchain Marketplace
+- Onchain Game Catalog
+- BibliothecaDAO metrics
 
-- Getting Started
-- Contributing
-- License
+#### Quick Links
 
-### Getting Started
-
-- [`apps/nextjs`](https://bibliothecadao.github.io/frontend) - The next.js Frontend
-- [`packages/subgraph`](https://bibliothecadao.github.io/subgraph) - The L1 Starknet Messaging Indexer for Bridge Transactions
-- [`packages/apibara`](https://bibliothecadao.github.io/starknet-indexer) = The L2 indexer for Bridge and Marketplace 
-
-### Running the app
-
-This will launch storybook and the Realms.World client.
-
-```bash
-bun i
-```
-
-```bash
-bun run dev
-```
-
-## Enviroment Variables
-
-Depending on which environment you want to run, either copy the values from `.env.sepolia` or `.env.mainnet` into your `.env` file.
-
-### Documentation
-
-Available at [Realms.World Docs](https://docs.realms.world)
+- [Getting Started](#getting-started)
+- [Client Documentation](https://docs.realms.world/client-development)
+- [Developer Documentation](https://docs.realms.world)
+- [Add a Game](https://docs.realms.world/games)
+- [Add a Event](https://docs.realms.world/events)
+- [Add a Post](https://docs.realms.world/posts)
+- [License](./LICENSE)
 
 ### Contributing
 
-We welcome contributions from the community to help improve Realms.World. If you are interested in contributing, please follow these steps:
+We welcome contributions from the community to help improve Realms.World.
 
-1. Fork the repository.
+1. Fork the repository. Read the [guide](https://docs.realms.world/)
 2. Create a new branch for your changes.
-3. Make your changes and commit them to your branch.
+3. Make your changes and commit them to your branch. Make sure CI passes.
 4. Submit a pull request with a detailed description of your changes.
 
 We will review your contribution and provide feedback. Once your changes have been approved, they will be merged into the main branch.
 
-### To add a Game
-
-Check out the docs at [Add Data Docs](https://docs.realms.world/data) - WIP for Loot Survivor mods
-
-### License
+## License
 
 Realms.World is an open-source project released under the MIT License. This license allows you to freely use, modify, and distribute the code, as long as you include the original copyright and permission notice in any copy of the software or substantial portions of it.

documentation/README.md

@@ -0,0 +1 @@
+## Docs to Realms.World Client

documentation/docs/components/Footer.tsx

@@ -0,0 +1,8 @@
+export function Footer() {
+  return (
+    <div className="footer">
+      <div>Released under the MIT License.</div>
+      <div>Copyright © 2022-present Realms World</div>
+    </div>
+  );
+}

documentation/docs/pages/client-development.md

@@ -0,0 +1,41 @@
+# Client Development
+
+### Overview
+
+[Realms.World](https://realms.world) is built using Next.js 14, which allows for a seamless integration of server and client components. The application aims to maximize performance and scalability by leveraging Vercel's cache and local cache and is built on top of the [T3 Stack](https://github.com/t3-oss/create-t3-turbo)
+
+### Server Components
+
+Any component/data that can be rendered/fetched on the server should be rendered on the server to optimize the user experience. Page layouts are the most obvious examples of server-rendered components. Within these layouts, server components can be used to add interactivity. This abstraction ensures that page loads are as fast as possible for the end user.
+
+## Getting Started
+
+We use [bun](https://bun.sh/) as package manager so you will need it installed if you don't already have it.
+
+```bash
+curl -fsSL https://bun.sh/install | bash
+```
+
+Depending on which enviroment you want to run, either copy the values from `.env.sepolia` or `.env.mainnet` into your `.env` file.
+
+```bash
+# To set up environment variables for Sepolia
+cp .env.sepolia .env
+
+# To set up environment variables for Mainnet
+cp .env.mainnet .env
+```
+
+Once bun and your .env is setup, run:
+
+```bash
+bun i
+```
+
+```bash
+bun run dev
+```
+
+## Indexers
+
+You only need to run the subgraph and/or Apibara indexers locally if you want to preview changes, otherwise just use the deployed instances/database URL (as set in the `.env` file)