creating a new PR to see if Gitbook will see it

README.md

@@ -1,182 +1,2 @@
-![Obol Logo](https://obol.tech/obolnetwork.png)
+# Page
 
-<h1 align="center">Obol Network</h1>
-
-This repo intends to serve as a documentation site for the Obol Network.
-
-## Quickstart
-
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
-
-### Installation
-
-```shell
-$ yarn
-```
-
-### Local Development
-
-```shell
-$ yarn 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
-
-```shell
-$ yarn build
-```
-
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-### Deployment
-
-This repo is configured with Github Actions to deploy the built site to github pages. Committing or merging to master will update the production documentation site.
-
-### Versioning
-
-Docusaurus can manage multiple versions of your docs.
-
-#### Create a docs version
-
-Release a version v0.5.0 of your project:
-
-Control/Command+F the `/docs/` folder for the current version, and update all references to the upcoming version.
-
-Now you are ready to create the next version by running the following command.
-
-```shell
-yarn run version v0.5.0
-```
-
-The `docs` folder is copied into `versioned_docs/version-v0.5.0` and `versions.json` is created.
-
-Your docs now have 2 versions:
-
-- `v0.5.0` at `http://localhost:3000/docs/` for the version v0.5.0 docs
-- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
-
-Now push this to a branch and merge to main to release this version update publicly.
-
-#### Add a Version Dropdown
-
-To navigate seamlessly across versions, add a version dropdown.
-
-Modify the `docusaurus.config.js` file:
-
-```js title="docusaurus.config.js"
-module.exports = {
-  themeConfig: {
-    navbar: {
-      items: [
-        // highlight-start
-        {
-          type: "docsVersionDropdown",
-        },
-        // highlight-end
-      ],
-    },
-  },
-};
-```
-
-The docs version dropdown appears in your navbar:
-
-![Docs Version Dropdown](/img/tutorial/docsVersionDropdown.png)
-
-#### Update an existing version
-
-It is possible to edit versioned docs in their respective folder:
-
-- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
-- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`
-
-### Translate your site
-
-Let's translate `docs/intro.md` to French.
-
-#### Configure i18n
-
-Modify `docusaurus.config.js` to add support for the `fr` locale:
-
-```js title="docusaurus.config.js"
-module.exports = {
-  i18n: {
-    defaultLocale: "en",
-    locales: ["en", "fr"],
-  },
-};
-```
-
-#### Translate a doc
-
-Copy the `docs/intro.md` file to the `i18n/fr` folder:
-
-```shell
-mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
-
-cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
-```
-
-Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
-
-#### Start your localized site
-
-Start your site on the French locale:
-
-```shell
-npm run start -- --locale fr
-```
-
-Your localized site is accessible at `http://localhost:3000/fr/` and the `Getting Started` page is translated.
-
-:::caution
-
-In development, you can only use one locale at the same time.
-
-:::
-
-#### Add a Locale Dropdown
-
-To navigate seamlessly across languages, add a locale dropdown.
-
-Modify the `docusaurus.config.js` file:
-
-```js title="docusaurus.config.js"
-module.exports = {
-  themeConfig: {
-    navbar: {
-      items: [
-        // highlight-start
-        {
-          type: "localeDropdown",
-        },
-        // highlight-end
-      ],
-    },
-  },
-};
-```
-
-The locale dropdown now appears in your navbar:
-
-![Locale Dropdown](/img/tutorial/localeDropdown.png)
-
-#### Build your localized site
-
-Build your site for a specific locale:
-
-```shell
-npm run build -- --locale fr
-```
-
-Or build your site to include all the locales at once:
-
-```shell
-npm run build
-```
-
-## Notes/Bugs/Gotchas
-
-Configure a documentation page's extra details with these [metadata fields](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-frontmatter).

SUMMARY.md

@@ -0,0 +1,3 @@
+# Table of contents
+
+* [Page](README.md)

docs/.github/README.md

@@ -0,0 +1,2 @@
+# .github
+

docs/.github/issue_template/README.md

@@ -0,0 +1,2 @@
+# ISSUE\_TEMPLATE
+

docs/.github/issue_template/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: 🐞 Bug report
+about: Create a report to help us improve
+---
+
+## Describe the bug
+<!--A clear and concise description of what the bug is.-->
+
+## To Reproduce
+<!--Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error-->
+
+## Expected behavior
+<!--A clear and concise description of what you expected to happen.-->
+
+## Screenshots
+<!--If applicable, add screenshots to help explain your problem.-->
+
+## Additional context
+<!--Add any other context about the problem here.-->

docs/.github/issue_template/feature_request.md

@@ -0,0 +1,38 @@
+---
+name: "\U0001F680 Feature or Improvement Ticket"
+about: Create a new feature or suggest an improvement
+---
+
+# 🎯 Problem to be solved
+
+<!--Describe in detail the problem to be solved by this feature/enhancement and why it is important.-->
+
+- [ ] Link to the codebase issue that prompted this docs change
+
+# 🛠️ Proposed solution
+
+<!--Describe in detail the proposed solution.-->
+
+- [ ] For major overhaul of docs, design doc link: 
+
+# 🧪 Tests
+
+<!--Delete any irrelevant item and add other mandatory tests that should be passing-->
+
+- [ ] Netlify deployment build tests passing
+
+# 👐 Additional acceptance criteria
+
+<!--Delete any irrelevant item and add any additional acceptance criteria for this issue to be marked as closed.-->
+
+# ❌ Out of Scope
+
+<!--If there is anything to highlight as out of scope for this issue, please outline it here.-->
+
+<!--# ✅ Issue Creation Checklist
+
+Delete this section once you have validated that this ticket is
+- [ ] Feasible: it can be completed in one sprint (2 weeks) by a single person, otherwise split the ticket into multiple issues
+- [ ] Actionable: any contributor must be able to determine immediately what needs to be done to complete the ticket
+- [ ] Clear: all contributors have a shared understanding of what it means
+- [ ] Testable: there is an effective way to determine if the functionality works as expected -->

docs/.github/pull_request_template.md

@@ -0,0 +1,8 @@
+## Summary
+<!--Provide an overview of your changes.-->
+
+## Details
+<!--Add more context to describe your changes if needed-->
+
+ticket:
+<!--link to a GitHub issue (or 'none' if PR is trivial)-->

docs/README.md

@@ -0,0 +1,2 @@
+# Page
+

docs/SUMMARY.md

@@ -0,0 +1,3 @@
+# Table of contents
+
+* [Page](README.md)

docs/docs/README.md

@@ -0,0 +1,2 @@
+# docs
+

docs/docs/adv/README.md

@@ -0,0 +1,2 @@
+# adv
+

docs/docs/adv/advanced/README.md

@@ -0,0 +1,2 @@
+# advanced
+

docs/docs/adv/advanced/adv-docker-configs.md

@@ -0,0 +1,38 @@
+---
+sidebar_position: 6
+description: Use advanced docker-compose features to have more flexibility and power to change the default configuration.
+---
+
+# Advanced Docker Configs
+
+:::info
+This section is intended for *docker power users*, i.e.: for those who are familiar with working with `docker compose` and want to have more flexibility and power to change the default configuration.
+:::
+
+We use the "Multiple Compose File" feature which provides a very powerful way to override any configuration in `docker-compose.yml` without needing to modify git-checked-in files since that results in conflicts when upgrading this repo.
+See [this](https://docs.docker.com/compose/extends/#multiple-compose-files) for more details.
+
+There are some additional compose files in [this repository](https://github.com/ObolNetwork/charon-distributed-validator-node/), `compose-debug.yml` and `docker-compose.override.yml.sample`, along-with the default `docker-compose.yml` file that you can use for this purpose.
+
+- `compose-debug.yml` contains some additional containers that developers can use for debugging, like `jaeger`. To achieve this, you can run:
+
+```shell
+docker compose -f docker-compose.yml -f compose-debug.yml up
+```
+
+- `docker-compose.override.yml.sample` is intended to override the default configuration provided in `docker-compose.yml`. This is useful when, for example, you wish to add port mappings or want to disable a container.
+
+- To use it, just copy the sample file to `docker-compose.override.yml` and customise it to your liking. Please create this file ONLY when you want to tweak something. This is because the default override file is empty and docker errors if you provide an empty compose file.
+
+```shell
+cp docker-compose.override.yml.sample docker-compose.override.yml
+
+# Tweak docker-compose.override.yml and then run docker compose up
+docker compose up
+```
+
+- You can also run all these compose files together. This is desirable when you want to use both the features. For example, you may want to have some debugging containers AND also want to override some defaults. To achieve this, you can run:
+
+```shell
+docker compose -f docker-compose.yml -f docker-compose.override.yml -f compose-debug.yml up
+```