Skip to content

Commit

Permalink
feat(docs): include initial content for additional resources section (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
xavier506 authored Dec 28, 2023
1 parent 50870d5 commit 72f3756
Show file tree
Hide file tree
Showing 4 changed files with 395 additions and 11 deletions.
31 changes: 28 additions & 3 deletions docs/resources/additional-resources.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
---
title: Additional resources
title: Additional Resources
sidebar_position: 1
---

Additional resources and reading materials
Community and support channels
This page provides a curated list of additional resources for further exploration and understanding of Defactor. Here you'll find links to various websites, documentation, articles, and other relevant materials that can enhance your knowledge and engagement with our project.

## Official Websites

- [Defactor Main Site](https://www.defactor.com)
- The main landing page for Defactor, providing an overview of the project.

## Documentation

-


## Community and Social Media

- [Twitter](https://twitter.com/defactor_)
- Follow us on Twitter for the latest news and updates.

## Articles and Blogs

-

## Video Tutorials

-


Feel free to explore these resources to deepen your understanding and engagement with the Defactor ecosystem.
40 changes: 35 additions & 5 deletions docs/resources/faqs.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,39 @@
---
title: FAQS
title: FAQs
sidebar_position: 3
---

- Frequently asked questions with comprehensive answers
- Common issues and their solutions
- Debugging tips
- How to report bugs or contribute to the documentation
# Frequently Asked Questions

## Common Questions

### Q1: How do I get started with Defactor development?
**A:** To get started, ensure you have the latest version of Defactor installed. Follow the setup instructions in our [Getting Started Guide](link-to-getting-started).

### Q2: Where can I find API documentation?
**A:** The API documentation is available [here](link-to-api-docs). It includes detailed descriptions of API endpoints, parameters, and examples.


## Common Issues and Solutions

### Q1:
**A:**

### Q2:
**A:**

## Debugging Tips

### Q1:
**A:**

### Q2:
**A:**

## Reporting Bugs & Contributing

### Q1: How do I report a bug in Defactor?
**A:** Report bugs through our [Issue Tracker](link-to-issue-tracker). Include detailed steps to reproduce, environment details, and logs if possible.

### Q2: How can I contribute to the Defactor documentation?
**A:** Contributions are welcome! Please refer to our [Contributor's Guide](link-to-contributors-guide) for guidelines on submitting documentation updates or enhancements.
274 changes: 273 additions & 1 deletion docs/resources/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,277 @@ title: Glossary
sidebar_position: 3
---

List of terms necessary to understand the contents of this guide.

Definitions of key terms and concepts used in the documentation
## **A**


### ACL (Access Control List)

A traffic filter of a list of networks and correlated actions used to improve security. Block or allow users to access specific resources.

* * *

### API (Application Programming Interface)

Set of functions and procedures that allow the creation of applications that access the characteristics or data of an operating system, application or other specific service.

* * *

## **B**

### Blockchain
A distributed database or ledger that is shared among the nodes of a computer network. It stores information electronically in digital format and is known for its secure design, decentralization, and resistance to modification of its data.

* * *

### Block
The fundamental unit of a blockchain, which contains a collection of transactions that have been validated by the network and permanently recorded.

* * *

### Bitcoin
The first and most well-known cryptocurrency, operating on a decentralized peer-to-peer network. It was introduced in 2009 by an unknown person or group of people using the name Satoshi Nakamoto.

* * *

### Byzantine Fault Tolerance (BFT)
A property of a system that allows it to continue operating properly in the event of failures of some of its components. In the context of blockchain, this refers to the system's ability to resist the problems associated with the Byzantine Generals' Problem.

* * *

### BIP (Bitcoin Improvement Proposal)
A design document for introducing features or information to Bitcoin. This is the standard way of communicating ideas since Bitcoin is a decentralized project.

* * *

### BaaS (Blockchain as a Service)
A cloud-based service that enables users to develop their own digital products by working with blockchain. These can include smart contracts, decentralized applications (DApps), or other services without the need to set up or manage the blockchain infrastructure.

* * *

### Bear Market
A market condition where prices are falling or are expected to fall. It often leads to a downward economic trend and is characterized by pessimism.

* * *

### Bull Market
A market condition where prices are rising or are expected to rise. This term is typically used in the context of financial markets and reflects an upward trend and investor confidence.

* * *

### Burned Tokens
Refers to tokens that have been permanently removed from circulation. This is typically done by sending the tokens to an unusable account or address. Token burning can be used as a tool for managing inflation or for other economic strategies within a cryptocurrency ecosystem.

* * *

### Bridge
In the context of blockchain, a bridge refers to a connection that allows the transfer of tokens or data between two different blockchain ecosystems.

* * *

### Block Explorer
An online tool to view all transactions, past and present, on the blockchain. It provides information about the blockchain's activity, including transaction histories and balances of addresses.

* * *


## **C**

### Consensus Algorithm
A process in blockchain networks used to achieve agreement on a single data value or a single state of the network among distributed processes or multi-agent systems.

* * *

### Cryptocurrency
A digital or virtual currency that uses cryptography for security and operates independently of a central bank, often used in blockchain systems.

* * *

## **D**

### Decentralized Application (DApp)
An application that runs on a decentralized network, avoiding a single point of failure or control.

* * *

### Distributed Ledger
A consensus of replicated, shared, and synchronized digital data geographically spread across multiple sites, countries, or institutions.

* * *

## **E**

### Ethereum
An open-source blockchain platform that enables the creation of smart contracts and decentralized applications (DApps).

* * *

### ERC-20
A standard for creating and issuing smart contract tokens on the Ethereum blockchain.

* * *

## **F**

### Fork
In blockchain, a change or divergence in the protocol that creates two separate paths, either temporarily or permanently.

* * *

### Fiat
Traditional government-issued currency, such as dollars or euros, not backed by a physical commodity.

* * *

## **G**

### Gas (Blockchain)
A unit of measure for the amount of computational effort required to execute operations on the Ethereum network.

* * *

## **H**

### Hash Rate
A measure of computational power per second used in mining and processing transactions in a blockchain network.

* * *

## **I**

### ICO (Initial Coin Offering)
A fundraising mechanism where new projects sell their underlying crypto tokens in exchange for early capital.

* * *

### IPFS (InterPlanetary File System)
A protocol and peer-to-peer network for storing and sharing data in a distributed file system.

* * *

## **J**

### JSON-RPC
A remote procedure call protocol encoded in JSON, used to interact with nodes in a blockchain network.

* * *

## **K**

### KYC (Know Your Customer)
The process of a business verifying the identity of its clients, commonly used in the context of financial institutions.

* * *

## **L**

### Layer 2
A secondary framework or protocol built on top of an existing blockchain system, designed to solve its scalability and speed issues.

* * *

### Ledger
A record of transactions maintained by a blockchain network, which is distributed and immutable.

* * *

## **M**

### Mining
The process of validating and recording transactions on a blockchain network by solving complex cryptographic puzzles.

* * *

### Multisig Wallet
A type of cryptocurrency wallet that requires multiple keys to authorize a transaction, enhancing security.

* * *

## **N**

### Node
A connection point in a network, in blockchain typically a computer that connects to a blockchain network.

* * *

### Non-Fungible Token (NFT)
A type of cryptographic token on a blockchain that represents a unique asset or property.

* * *

## **O**

### Oracle
In blockchain, a way of bringing real-world data into a blockchain to interact with smart contracts.

* * *

## **P**

### Private Key
A secret number that allows a user to access their cryptocurrency funds, crucial for security in blockchain transactions.

* * *

### Proof of Stake (PoS)
A type of consensus algorithm in blockchain networks where the creator of a new block is chosen via various combinations of random selection and wealth or age.

* * *

## **Q**

### Quantum Computing
A technology based on the principles of quantum theory, which explains the nature of energy and matter on the atomic and subatomic levels. It poses potential risks and advantages for blockchain technology.

* * *

## **R**

### RPC (Remote Procedure Call)
A protocol that allows a program to cause a procedure (subroutine) to execute in another address space, commonly used in blockchain networks for communication between nodes.

* * *

## **S**

### Smart Contract
A self-executing contract with the terms of the agreement directly written into lines of code, which exist across a distributed, decentralized blockchain network.

* * *

### Solidity
A programming language for writing smart contracts, primarily used for Ethereum.

* * *

## **T**

### Token
A digital unit designed with utility in mind, providing access and use of a larger crypto-economic system.

* * *

### Transaction Fee
In blockchain, a fee for conducting a transaction or executing a contract on the network, often related to the computational power required.

* * *

## **U**

### UXTO (Unspent Transaction Output)
A concept used in some blockchains, representing the amount of digital currency someone can spend.

* * *

## **V**

### Validator
In blockchain, especially in proof of stake systems, validators are responsible for maintaining the network and validating new transactions.

* * *

## **W**

### Wallet
A tool that allows users to interact
Loading

0 comments on commit 72f3756

Please sign in to comment.