Rootstock documentation pages utilize frontmatter, a customizable set of properties and components that controls the page behavior (e.g., title, description, cards, filtering, etc.).
Example:
---
sidebar_label: Rootstock Fundamentals
sidebar_position: 2
title: Rootstock Fundamentals
tags: [rsk, rootstock, beginner, concepts]
description: Rootstock is the first and longest-lasting Bitcoin sidechain. It is the only layer 2 solution that combines the security of Bitcoin's proof of work with Ethereum's smart contract capabilities.
render_features: 'powpeg-hsm-attestation-frame'
---
The provided frontmatter snippet demonstrates how to define several properties that control how the page is presented within the documentation website:
-
sidebar_label: This property sets the text displayed for the page in the navigation sidebar. Here, it's set to "Rootstock Fundamentals".
-
sidebar_position: This property determines the order of the page within the sidebar. In this case, the value 2 indicates a position below any entries with a lower number (and above those with a higher number).
-
title: This property sets the main title displayed for the page content. Here, it matches the sidebar label, "Rootstock Fundamentals".
-
tags: This property assigns keywords or tags to the page for categorization and searchability. Here, the page is tagged with "rsk", "rootstock", "beginner", and "concepts".
-
description: This property briefly describes the page's content, used for page previews or search results, this helps with SEO. Ensure your meta description is concise and compelling; providing a brief summary of your page's content is crucial for SEO. Keep the description within 150-160 characters, align it with user search intent, and naturally include relevant keywords to enhance readability.
Note: Tags are essential for improving our documentation search system. They help users find relevant information more easily. Don’t forget to include them in the front matter.
Maximum Tags: Limit tags in the front matter of your .md files to a maximum of five.
Relevance: Ensure tags are relevant to your content. They should help users find information quickly. Example, if you are writing an article about “How to deploy a smart contract on Rootstock using Rust” make sure to add “rust” as a tag.
Mandatory Tags: We have a set of mandatory tags for each section. See the table below for a list.
| Section | Mandatory Tags |
|---|---|
| Concepts | Concepts, rsk, rootstock |
| Developers | Developers, rsk, rootstock |
| Node Operators | node operators, rsk, rootstock |
| Resources | Resources, rsk, rootstock |
| Dev Tools | dev tools, rsk, rootstock |
Example:
---
title: My Documentation Title
tags: concepts, rsk, rootstock
---- Stay Updated: Regularly check for updates to our documentation to ensure you have the latest version.
- Updating Docs: Follow these steps to update a Docasaurus version.
The Rootstock Documentation was built with accessibility in mind. It uses a robust accessibility tool called Accessibe. This allows users with disabilities to customize their experience for easier navigation and information access.
To use the accessibility features, visit the Rootstock Docs and click on the icon(see gif below) at the bottom left of the screen. You can then set up your preferred accessibility features.
This section provides guidance on using various Docasaurus components effectively:
-
Codeblock: This is used to display code snippets for developers or to illustrate specific syntax.
- Example:
function greet(name) {
return "Hello, " + name + "!";
}
console.log(greet("World")); // Output: Hello, World!- Tabs:
- Use case: Organize related content with different functionalities or viewpoints.
- Example:
<Tabs>
<TabItem value="contribute" label="Contribute to Rootstock" default>
...
</TabItem>
<TabItem value="contest" label="Contest Themes">
...
</TabItem>
<TabItem value="requirements" label="Requirements">
...
</TabItem>
</Tabs>- Gallery Slider:
- Use case: Showcase a series of images or content that benefit from a swiping or sliding interface.
- Example: A documentation page for a product might use a gallery slider to display product screenshots.
- Table:
- Use case: Present structured data with clear rows and columns for easy comparison or reference.
- Example: A table comparing different features of various plans for a service and listing technical specifications of products, features, or functionalities.
- Headers:
- Use case: Organize your content and create a hierarchy for scannability. Use H1 for the main title, H2 for subheadings, and so on.
- Example:
# Heading level 1
## Heading level 2
### Heading level 3
#### Heading level 4
##### Heading level 5
###### Heading level 6-
List:
- Use case: Present items in a specific sequence (ordered list) or without order (unordered list).
- Example: Ordered list for installation steps, unordered list for a set of features.
-
Blockquotes:
- Use case: Highlight quoted text, differentiating it from your own writing.
- Example: Highlighting a user testimonial or an excerpt from another source.
-
Quotes:
- Use case: Include short in-line quotations within your text.
- Example: “As the saying goes, ‘A picture is worth a thousand words’.”
-
Images:
- Use case: Enhance understanding and visual appeal. Ensure images are relevant and of high quality.
- Example: An image can illustrate a product concept or demonstrate a user interface element.
-
Videos:
- Use case: Demonstrate functionalities, complex explanations, or walkthroughs.
- Example: A video tutorial for setting up a software program.
-
Admonitions:
- Use case: Highlight important notes, warnings, or tips to grab user attention.
- Example: A warning admonition about potential security risks or a note about browser compatibility.
-
Accordion:
- Use case: Present collapsible sections of content, useful for long lists or frequently asked questions.
- Example: An FAQ section where each question expands to reveal the answer upon clicking.
-
Cards:
- Use case: Display concise pieces of information in an organized and visually appealing way.
- Examples:
- Cards with filters: Filterable product cards based on category or price range.
- Cards with no links: Informational cards without requiring user clicks.
- Cards with no images: Cards displaying textual information only.
- Cards with images: Cards with an image and accompanying descriptive text.
-
Numbering
- To make the numbering work, ensure you don't add anything on the same line as the number, even if it's a text.
- A good example
[]
a bad example
[]
Rootstock's full technology stack is developed on the foundation of bitcoin.
This includes everything from Rootstock smart contracts to the Rootstock Infrastructure Framework. The stack aims to establish a more equitable and inclusive financial system.
Rootstock is the first open-source smart contract platform powered by the Bitcoin network. It aims to enhance the Bitcoin ecosystem by facilitating smart contracts, near-instant payments, and greater scalability.
Key Features:
- Smart Contracts on Bitcoin: Rootstock Smart Contracts enable developers to build secure and scalable DeFi, NFT, and Web3 applications on the Bitcoin network.
- Enhanced Security: Rootstock inherits Bitcoin's battle-tested security, providing a robust foundation for your decentralized projects.
- Interoperability: Rootstock bridges the gap between Bitcoin and Ethereum, fostering innovation across ecosystems.
git clone https://github.com/rsksmart/devportal.git
Join the vibrant Rootstock community to connect with developers, engage in discussions, and stay updated on the latest advancements:
- Discord: https://discord.com/invite/rootstock