status-im
/
nimbus-eth1
mirror of https://github.com/status-im/nimbus-eth1.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nimbus-eth1/fluffy/docs/the_fluffy_book/mkdocs.yml

90 lines
2.2 KiB
YAML
Raw Permalink Normal View History

First go at the Fluffy book using mkdocs as for nimbus.guide (#1842) * First go at the Fluffy book using mkdocs as for nimbus.guide * reorganize a little the index page * Add small paragraph on the what in index page
2023-10-23 13:29:54 +00:00
# Nimbus Fluffy book
Generalise prune mode option 4 different db models (#2139) * Update README * Nimbus-main: replaced `PruneMode` options by `ChainDbMode` options details: For the legacy database, this changes the phrase - `conf.pruneMode == PruneMode.Full` to the expression + `conf.chainDbMode == ChainDbMode.Prune`. * Fix issues moaned about by NIM compiler * Fix copyright year
2024-04-17 18:09:55 +00:00
# Copyright (c) 2023-2024 Status Research & Development GmbH
First go at the Fluffy book using mkdocs as for nimbus.guide (#1842) * First go at the Fluffy book using mkdocs as for nimbus.guide * reorganize a little the index page * Add small paragraph on the what in index page
2023-10-23 13:29:54 +00:00
# Licensed and distributed under either of
# * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT).
# * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0).
# at your option. This file may not be copied, modified, or distributed except according to those terms.
site_name: The Nimbus Fluffy Guide
theme:
name: material
features:
- navigation.expand
- navigation.tabs
- navigation.top
- content.tabs.link
palette:
Adjust color scheme for fluffy.guide (#2144) Use the same scheme as for the nimbus.guide. Two differences however: - Set the dark scheme as default, considering the new nimbus.team website also has dark as default. - Remove the orange/amber for the light scheme, considering the light version of nimbus.team has no more orange.
2024-04-22 13:33:51 +00:00
- scheme: slate
primary: black
accent: light blue
toggle:
icon: material/brightness-4
name: Switch to light mode
- scheme: default
primary: white
accent: light blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
extra_css:
- stylesheets/extra.css
First go at the Fluffy book using mkdocs as for nimbus.guide (#1842) * First go at the Fluffy book using mkdocs as for nimbus.guide * reorganize a little the index page * Add small paragraph on the what in index page
2023-10-23 13:29:54 +00:00
# Support urls previously used by mdbook
use_directory_urls: false
repo_url: https://github.com/status-im/nimbus-eth1
Add more documentation to the fluffy book and reorganize it (#1856) Moved pretty much everything from the readme.md file now to the book and structured it better to be more accessible.
2023-10-24 16:18:30 +00:00
edit_uri: edit/master/fluffy/docs/the_fluffy_book/docs
docs_dir: docs
First go at the Fluffy book using mkdocs as for nimbus.guide (#1842) * First go at the Fluffy book using mkdocs as for nimbus.guide * reorganize a little the index page * Add small paragraph on the what in index page
2023-10-23 13:29:54 +00:00
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- tables
- toc:
toc_depth: 3
permalink: "#"
nav:
- Home:
- 'index.md'
- Getting started:
- 'quick-start.md'
- 'quick-start-windows.md'
- 'quick-start-docker.md'
- How-to:
Add more documentation to the fluffy book and reorganize it (#1856) Moved pretty much everything from the readme.md file now to the book and structured it better to be more accessible.
2023-10-24 16:18:30 +00:00
- Installation:
- 'prerequisites.md'
- 'build-from-source.md'
- 'upgrade.md'
- 'metrics.md'
- Access the network:
- 'connect-to-portal.md'
- 'access-content.md'
First go at the Fluffy book using mkdocs as for nimbus.guide (#1842) * First go at the Fluffy book using mkdocs as for nimbus.guide * reorganize a little the index page * Add small paragraph on the what in index page
2023-10-23 13:29:54 +00:00
- Portal bridge:
- 'history-content-bridging.md'
- 'beacon-content-bridging.md'
Fluffy state bridge docs (#2632) * Don't proxy implemented state JSON-RPC endpoints. Fix minor issue in testnet script. * Add docs covering usage of the Fluffy state bridge.
2024-09-18 03:56:20 +00:00
- 'state-content-bridging.md'
Add docs on pruning in Fluffy (#2137)
2024-04-17 12:06:53 +00:00
- 'db_pruning.md'
Add more documentation to the fluffy book and reorganize it (#1856) Moved pretty much everything from the readme.md file now to the book and structured it better to be more accessible.
2023-10-24 16:18:30 +00:00
- Developers:
- 'basics-for-developers.md'
- 'test-suite.md'
Add a brief doc page on how to add documentation (#2617)
2024-09-12 08:50:45 +00:00
- 'adding-documentation.md'
First go at the Fluffy book using mkdocs as for nimbus.guide (#1842) * First go at the Fluffy book using mkdocs as for nimbus.guide * reorganize a little the index page * Add small paragraph on the what in index page
2023-10-23 13:29:54 +00:00
- Local testnet:
- 'run-local-testnet.md'
- 'testnet-history-network.md'
- 'testnet-beacon-network.md'
Fix, improve and update some of the fluffy docs (#2743)
2024-10-16 11:48:34 +00:00
- 'fluffy-with-hive.md'
First go at the Fluffy book using mkdocs as for nimbus.guide (#1842) * First go at the Fluffy book using mkdocs as for nimbus.guide * reorganize a little the index page * Add small paragraph on the what in index page
2023-10-23 13:29:54 +00:00
- 'protocol-interop-testing.md'
- 'eth-data-exporter.md'