Skip to content

Commit c48ece2

Browse files
committed
Update github repo url
1 parent 40ca06b commit c48ece2

File tree

2 files changed

+45
-45
lines changed

2 files changed

+45
-45
lines changed

CONTRIBUTING_DOCS.md

+43-43
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ In this guide, I will outline steps to follow as a new user to our developer doc
66

77
### **Main Navigation Items**
88

9-
* **Concept:** This section will provide a high-level overview of your product, its purpose, and target audience. It's essentially the "what" of your product.
10-
* **Developers:** This section is primarily for those building on top of your product. It will include technical documentation, APIs, SDKs, and other developer-focused resources.
11-
* **Node Operators:** This section caters to those managing the infrastructure of your product. It will cover setup, maintenance, troubleshooting, and other operational aspects.
12-
* **Resources:** This section will house additional materials like tutorials, case studies, whitepapers, and other supporting documents.
9+
* **Concept:** This section will provide a high-level overview of your product, its purpose, and target audience. It's essentially the "what" of your product.
10+
* **Developers:** This section is primarily for those building on top of your product. It will include technical documentation, APIs, SDKs, and other developer-focused resources.
11+
* **Node Operators:** This section caters to those managing the infrastructure of your product. It will cover setup, maintenance, troubleshooting, and other operational aspects.
12+
* **Resources:** This section will house additional materials like tutorials, case studies, whitepapers, and other supporting documents.
1313
* **Devtools:** This section will provide tools and utilities to aid developers in their work.
1414

1515
### **Content Placement and Categorization**
@@ -18,72 +18,72 @@ In this guide, I will outline steps to follow as a new user to our developer doc
1818

1919
This section will cover the theoretical aspects and foundational concepts relevant to the platform or technology. The content will include:
2020

21-
* **Core Principles**: Articles explaining the core principles and underlying philosophies of the technology or platform.
22-
* **Architectural Overview**: In-depth discussions on system architecture, including components, data flow, and system interactions.
23-
* **Key Terminologies**: Glossaries and explanations of key terms, jargon, and acronyms used in the field.
24-
* **Security Concepts**: Detailed explanations of security principles, common threats, and best practices for securing applications.
25-
* **Consensus Mechanisms**: Articles on various consensus mechanisms, their pros and cons, and how they are implemented.
26-
* **Scalability and Performance**: Discussions on scalability strategies, performance optimization, and handling high-load scenarios.
21+
* **Core Principles**: Articles explaining the core principles and underlying philosophies of the technology or platform.
22+
* **Architectural Overview**: In-depth discussions on system architecture, including components, data flow, and system interactions.
23+
* **Key Terminologies**: Glossaries and explanations of key terms, jargon, and acronyms used in the field.
24+
* **Security Concepts**: Detailed explanations of security principles, common threats, and best practices for securing applications.
25+
* **Consensus Mechanisms**: Articles on various consensus mechanisms, their pros and cons, and how they are implemented.
26+
* **Scalability and Performance**: Discussions on scalability strategies, performance optimization, and handling high-load scenarios.
2727
* **Regulatory and Compliance**: Information on legal and regulatory considerations, compliance requirements, and industry standards.
2828

2929
#### **Developers Section**
3030

31-
* **New pages or items:** A dedicated "Getting Started" section within the appropriate navigation item (e.g., Developers, Node Operators) can house one-page tutorials.
32-
* **Guides:** These should primarily reside under the "Developers" section.
33-
* **Integrations guides:** These will be part of the "Developers" section, detailing how to integrate the product with other systems.
31+
* **New pages or items:** A dedicated "Getting Started" section within the appropriate navigation item (e.g., Developers, Node Operators) can house one-page tutorials.
32+
* **Guides:** These should primarily reside under the "Developers" section.
33+
* **Integrations guides:** These will be part of the "Developers" section, detailing how to integrate the product with other systems.
3434
* **User guides:** These belong under the "Concept" section as they explain how to use the product rather than integrate with it.
3535

3636

3737
#### **Node Operators Section**
3838

3939
This section will provide practical information for node operators, focusing on setup, maintenance, and troubleshooting. The content will include:
4040

41-
* Node Installation: Step-by-step guides on installing and configuring nodes on different operating systems.
42-
* Network Participation: Instructions on how to join the network, participate in consensus, and maintain uptime.
43-
* Security and Hardening: Best practices for securing nodes, including firewall configurations, intrusion detection, and regular updates.
44-
* Monitoring and Alerts: Guides on setting up monitoring tools, configuring alerts, and ensuring node health.
45-
* Performance Tuning: Tips and techniques for optimizing node performance, resource management, and handling peak loads.
46-
* Backup and Recovery: Procedures for backing up node data, disaster recovery plans, and restoring nodes after failures.
41+
* Node Installation: Step-by-step guides on installing and configuring nodes on different operating systems.
42+
* Network Participation: Instructions on how to join the network, participate in consensus, and maintain uptime.
43+
* Security and Hardening: Best practices for securing nodes, including firewall configurations, intrusion detection, and regular updates.
44+
* Monitoring and Alerts: Guides on setting up monitoring tools, configuring alerts, and ensuring node health.
45+
* Performance Tuning: Tips and techniques for optimizing node performance, resource management, and handling peak loads.
46+
* Backup and Recovery: Procedures for backing up node data, disaster recovery plans, and restoring nodes after failures.
4747
* Community and Support: Information on community forums, support channels, and how to get help from the community or official support.
4848

4949
#### **Resources Section**
5050

5151
This section will serve as a repository of useful resources, documentation, and tools for developers and node operators. The content will include:
5252

53-
* Official Documentation: Links to official documentation, including API references, technical whitepapers, and user manuals.
54-
* Tutorials and Courses: Curated list of tutorials, online courses, and learning resources.
55-
* Libraries and Frameworks: Information on popular libraries, frameworks, and SDKs relevant to the platform.
56-
* Cheat Sheets and Quick References: Handy cheat sheets, quick reference guides, and FAQs for quick problem-solving.
57-
* Community Resources: Links to community-generated content, blogs, forums, and discussion groups.
58-
* Open Source Projects: Information on open-source projects, how to contribute, and where to find them.
53+
* Official Documentation: Links to official documentation, including API references, technical whitepapers, and user manuals.
54+
* Tutorials and Courses: Curated list of tutorials, online courses, and learning resources.
55+
* Libraries and Frameworks: Information on popular libraries, frameworks, and SDKs relevant to the platform.
56+
* Cheat Sheets and Quick References: Handy cheat sheets, quick reference guides, and FAQs for quick problem-solving.
57+
* Community Resources: Links to community-generated content, blogs, forums, and discussion groups.
58+
* Open Source Projects: Information on open-source projects, how to contribute, and where to find them.
5959
* External Tools: Links to external tools and services that can aid in development, testing, and deployment.
6060

6161
#### **DevTools Section**
6262

6363
This section will focus on development tools, with a particular emphasis on wallets and related tools. The content will include:
6464

65-
* Wallet Setup and Configuration: Guides on setting up and configuring various wallets for development and testing.
66-
* Wallet Integration: Tutorials on integrating wallets into applications, handling transactions, and managing keys.
67-
* Security Practices for Wallets: Best practices for securing wallets, including encryption, multi-signature setups, and secure key management.
68-
* Wallet APIs and SDKs: Information on wallet APIs, SDKs, and how to use them effectively.
69-
* Testing with Wallets: Instructions on testing transactions, simulating network conditions, and debugging wallet-related issues.
70-
* Popular Wallets: Reviews and comparisons of popular wallets, their features, and use cases.
65+
* Wallet Setup and Configuration: Guides on setting up and configuring various wallets for development and testing.
66+
* Wallet Integration: Tutorials on integrating wallets into applications, handling transactions, and managing keys.
67+
* Security Practices for Wallets: Best practices for securing wallets, including encryption, multi-signature setups, and secure key management.
68+
* Wallet APIs and SDKs: Information on wallet APIs, SDKs, and how to use them effectively.
69+
* Testing with Wallets: Instructions on testing transactions, simulating network conditions, and debugging wallet-related issues.
70+
* Popular Wallets: Reviews and comparisons of popular wallets, their features, and use cases.
7171
* Community Tools: Information on community-developed tools and plugins that enhance wallet functionality or ease of use.
7272

7373
#### **Codebase Overview**
7474

75-
To contribute to our developer documentation, follow these [steps to clone](https://github.com/rsksmart/devportal-rootstock) the repository and get started.
75+
To contribute to our developer documentation, follow these [steps to clone](https://github.com/rsksmart/devportal) the repository and get started.
7676

7777
Then, navigate to the `/doc` folder.
7878

7979
We recommend using Visual Studio Code (VSCode) or any text editor capable of previewing Markdown changes, as our documentation is written in Markdown.
8080

8181
Within the `/doc` folder, you will find the following directories:
8282

83-
* `01-concepts`
84-
* `02-developers`
85-
* `03-node-operators`
86-
* `04-resources`
83+
* `01-concepts`
84+
* `02-developers`
85+
* `03-node-operators`
86+
* `04-resources`
8787
* `05-dev-tools`
8888

8989
Add your content to the appropriate directory based on the topic it pertains to.
@@ -94,7 +94,7 @@ Add your content to the appropriate directory based on the topic it pertains to.
9494

9595
![Folder Numbering](/static/img/folder_numbering.png)
9696

97-
2. When adding content, please ensure you:
97+
2. When adding content, please ensure you:
9898
* Include a filter for each new page or piece of content. Each folder should have an `index.md` file that looks similar to this.
9999

100100
```
@@ -122,10 +122,10 @@ A filter in this context is a tool used to narrow down content based on specific
122122

123123
#### **Components of the Filter**
124124

125-
1. **Filter Tag**: `<Filter>`
126-
* This is the main component that wraps around the filter options.
127-
2. **values**: This is an attribute of the `Filter` component that holds an array of objects. Each object represents a filter option.
128-
3. **label**: This is the text that will be displayed to users. In this case, 'From Ethereum'.
125+
1. **Filter Tag**: `<Filter>`
126+
* This is the main component that wraps around the filter options.
127+
2. **values**: This is an attribute of the `Filter` component that holds an array of objects. Each object represents a filter option.
128+
3. **label**: This is the text that will be displayed to users. In this case, 'From Ethereum'.
129129
4. **value**: This is the internal value that the filter will use to identify the option. In this case, 'ethereum'.
130130

131131
| FilterItem Property | Description |
@@ -159,7 +159,7 @@ For each option you want to add, you will create an object with `label` and `val
159159

160160
`]}>`
161161

162-
* **label**: This is what users will see. It's user-friendly and descriptive.
162+
* **label**: This is what users will see. It's user-friendly and descriptive.
163163
* **value**: This is a more technical identifier used internally by the application.
164164

165-
> if you follow these guidelines, you'll help maintain the quality and organization of our documentation.
165+
> if you follow these guidelines, you'll help maintain the quality and organization of our documentation.

docusaurus.config.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ const config = {
2929
mendable : process.env.MENDABLE_KEY
3030
},
3131
homePage: {
32-
editUrl: 'https://github.com/rsksmart/devportal-rootstock/tree/main/',
32+
editUrl: 'https://github.com/rsksmart/devportal/tree/main/',
3333
},
3434
moreLinks : {
3535
changelog : {
@@ -100,7 +100,7 @@ const config = {
100100
showLastUpdateTime: true,
101101
// Please change this to your repo.
102102
// Remove this to remove the "edit this page" links.
103-
editUrl: 'https://github.com/rsksmart/devportal-rootstock/tree/main/'
103+
editUrl: 'https://github.com/rsksmart/devportal/tree/main/'
104104
},
105105
blog: {
106106
blogSidebarTitle: 'All posts',

0 commit comments

Comments
 (0)