Skip to content

Commit

Permalink
More fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
rastislavcore committed May 16, 2024
1 parent 696bc48 commit 5adb3db
Show file tree
Hide file tree
Showing 505 changed files with 1,413 additions and 1,289 deletions.
36 changes: 36 additions & 0 deletions .github/.markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"default": true,
"MD001": false,
"MD003": {
"style": "atx"
},
"MD004": false,
"MD012": false,
"MD013": false,
"MD014": false,
"MD022": false,
"MD024": false,
"MD025": false,
"MD026": false,
"MD028": false,
"MD031": false,
"MD032": false,
"MD033": {
"allowed_elements": [
"a",
"kbd",
"sub",
"sup"
]
},
"MD034": false,
"MD035": {
"style": "---"
},
"MD036": false,
"MD040": false,
"MD041": false,
"MD048": {
"style": "backtick"
}
}
25 changes: 25 additions & 0 deletions .github/workflows/markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Docs linter
on:
pull_request:
branches:
- master
paths:
- "docs/**/*.md"
- "versioned_docs/**/*.md"
- ".github/workflows/markdownlint.yml"
- ".github/.markdownlint.json"

jobs:
docs-linter:
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v3

- name: Markdown Lint
uses: ruzickap/action-my-markdown-linter@v1
with:
config_file: .github/lintconfig.yml
search_paths: |
docs/**/*.md
versioned_docs/**/*.md
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# CorePass Developer Hub
# Foxar Documentation

Welcome to the CorePass Developer Hub! This repository hosts the documentation for CorePass, a revolutionary platform for digital identity management that empowers users with full control over their personal data. Our documentation is built using Docusaurus system.
Welcome to the Foxar Documentation! This repository hosts the documentation for Foxar. The documentation is built using Docusaurus system.

## About CorePass
## About Foxar

CorePass is dedicated to revolutionizing the way digital identities are managed. By giving users control over their personal data, CorePass paves the way for a more secure and privacy-respecting digital environment.
Foxar is a blazing fast, portable and modular toolkit for Core BC app development.

## Getting Started with the Documentation

Expand Down Expand Up @@ -67,12 +67,8 @@ We welcome contributions to the CorePass Developer Hub! Whether it's improving t

## License

This project is licensed under the CORE license - see the [LICENSE](LICENSE) file for details.
This project is licensed under the CORE license.

## Support

For support, please open an issue in the GitHub issue tracker.

## Stay in Touch

For the latest updates and news about CorePass, follow us on social media or visit our [official website](https://corepass.net).
72 changes: 1 addition & 71 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,74 +5,4 @@ sidebar_position: 1

<img src={require("@site/static/img/docs/foxar-banner.png").default} style= {{borderRadius: "20px"}} />

> Foxar is a blazing fast, portable and modular toolkit for Core BC app development.
Foxar manages your dependencies, compiles your project, runs tests, deploys, and lets you interact with the chain from the command-line and via Ylem scripts.

## Sections

**[Getting Started](getting-started/installation)**

To get started with Foxar, install Foxar and set up your first project.

**[Projects](projects/creating-a-new-project.md)**

This section will give you an overview of how to create and work with existing projects.

**[Spark Overview](spark/overview-spark)**

The overview will give you all you need to know about how to use `spark` to develop, test, and deploy smart contracts.

**[Probe Overview](probe/probe-overview)**

Learn how to use `probe` to interact with smart contracts, send transactions, and get chain data from the command-line.

**[Shuttle Overview](shuttle/shuttle-overview)**

Learn about `shuttle`, Foxar's local node.

**[Pilot Overview](pilot/pilot-overview)**

Learn how to use `pilot`, Foxar's integrated Solidity REPL.

## Configuration

Guides on configuring Foxar.

- [Configuring with `foxar.toml`](./config/configuration/)
- [Continuous Integration](./config/continuous-integration.md)
- [Integrating with VSCode](./config/vscode.md)
- [Shell Autocompletion](./config/shell-autocompletion.md)
- [Static Analyzers](./config/static-analyzers.md)
- [Integrating with Hardhat](./config/hardhat.md)

## Tutorials

Tutorials on building smart contracts with Foxar.

- [Creating an NFT with Solmate](./tutorials/solmate-nft.md)
- [Docker and Foxar](./tutorials/foxar-docker.md)
- [Testing EIP-712 Signatures](./tutorials/testing-eip712.md)
- [Solidity Scripting](./tutorials/solidity-scripting.md)
- [Forking Mainnet with Probe and Shuttle](./tutorials/forking-mainnet-with-probe-shuttle.md)
- [Learning Foxar Videos](./tutorials/learn-foxar.md)

## Contributing

Help us improve Foxar: [Contributing](./contributing.md)

## Appendix

References, troubleshooting, and more.

- [FAQ](./faq.md)
- [CLI Reference](./reference/cli/cli-reference)
- [spark Commands](./reference/spark/)
- [probe Commands](./reference/probe/)
- [shuttle Commands](./reference/shuttle/shuttle-reference)
- [pilot Commands](./reference/pilot/pilot-reference)
- [Config Reference](./reference/config/config-reference)
- [Cheatcodes Reference](./reference/cheatcodes/cheatcodes-reference)
- [Spark Standard Library Reference](./reference/spark-std/spark-standart)
- [DSTest Reference](./reference/ds-test)
- [Miscellaneous](misc/miscellaneous)
> Canary version of Foxar documentation.
6 changes: 3 additions & 3 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function getLastVersion() {
}

function getNextVersionName() {
return "1.0.0";
return "Canary";
}

const config: Config = {
Expand All @@ -48,8 +48,8 @@ const config: Config = {
organizationName: "bchainhub",
projectName: "foxar-docs",

onBrokenLinks: "warn",
onBrokenAnchors: "warn",
onBrokenLinks: "throw",
onBrokenAnchors: "throw",
onBrokenMarkdownLinks: "warn",

i18n: {
Expand Down
Loading

0 comments on commit 5adb3db

Please sign in to comment.