Skip to content

Commit b5790ad

Browse files
stoobiestoobie
authored
docs: Migrate StarkNet docs from MDX/Docusaurus to AsciiDoc/Antora. (#55)
* Initial commit * Some css and hbs customizations. * Working on footer. * Working on style sheet * Changed name of folder from StarkEx to StarkNet * StarkNet AsciiDoc working within Antora. * Updated header links * Manual Code cleaning * More code cleaning, updated supplemental.css with fonts from current StarkNet docs, and modified the font-weight definitions to more prominently display bold characters. * Updated Transaction Structure with latest content. Moved header links to support responsive viewing * Updates from merged 0.10.0 PRs * Implemented various review comments. * deleted IBM fonts, edited css * Added public_html to .gitignore * Moved StarkNet docs into a subfolder called docs. * Added redirect file, moved tech docs to sub-director named * Removed some StarkEx files and other artifacts. * Tightening up directory structure * htaccess fix, removed * Fixed Math notation; favicon. * Added bare minimum to preview changes locally. * Fixed typos. (#65) * Add block explorer page (#66) * Added bare minimum to preview changes locally. * Added new topic listing StarkNet block explorers * Removed link to Medium article about Voyager. * Moved Block explorer page to precede `Developing on StarkNet`. * Fix command.adoc bugs (#64) * Css syntax fix. * Clarified setting the network. Moved gateway tip to top of page * Added generic section on command line syntax. * Implemented review comments * Added examples of setting read/write custom endpoints. * Fixed example. * Edited PR template * Removed Github workflows that applied to Docusaurus. Will add new workflows in separate branch/PR * updated Antora installation to be installed as part of project (#67) * Updated .gitignore * Added Viewblock to Block explorers topic. (#68) * Added workflow files to see if PR will pass checks * Updated Discord link (#69) * Added push.yml to create a release upon pushing (i.e. merging) a branch to dev or master.
1 parent 2c870d8 commit b5790ad

File tree

2,920 files changed

+656508
-11101
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,920 files changed

+656508
-11101
lines changed

‎.eslintignore

-5
This file was deleted.

‎.eslintrc.json

-41
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ If the PR is related to an open issue please link to it.
66
### Check List
77

88
- [ ] Changes have been done against dev branch, and PR does not conflict
9-
- [ ] Docs have been updated
10-
- [ ] PR title is follow the convention: `<docs/feat/fix/chore>(optional scope): <description>`, e.g: `fix: minor typos in code`
9+
- [ ] PR title follows the convention: `<feat/fix/chore>(optional scope): <description>`, e.g: `fix: minor typos in code`
10+
11+

‎.github/workflows/pull_request.yml

+9-23
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,21 @@ name: Pull request workflow
33
on: pull_request
44

55
jobs:
6-
format-check:
7-
name: Checking formatting
8-
runs-on: ubuntu-latest
9-
steps:
10-
- uses: actions/checkout@v2
11-
12-
- uses: actions/setup-node@v2
13-
with:
14-
node-version: 14
15-
16-
- name: Install node_modules
17-
run: yarn
18-
19-
- name: Run Prettier check
20-
run: yarn run format:check
216

227
test-deploy:
238
name: Test deploy
249
runs-on: ubuntu-latest
25-
needs: format-check
2610
steps:
27-
- uses: actions/checkout@v2
11+
- name: Checkout repository
12+
uses: actions/checkout@v2
2813

29-
- uses: actions/setup-node@v2
14+
- name: Install Node.js
15+
uses: actions/setup-node@v2
3016
with:
31-
node-version: 14
17+
node-version: 16
3218

33-
- name: Install node_modules
34-
run: yarn
19+
- name: Install Antora and the Antora Lunr Extension
20+
run: npm i antora @antora/[email protected]
3521

36-
- name: Run build
37-
run: yarn run build
22+
- name: Generate Site
23+
run: npx antora playbook.yml

‎.github/workflows/push.yml

+2-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919

2020
- uses: actions/setup-node@v2
2121
with:
22-
node-version: 14
22+
node-version: 16
2323

2424
- name: Install node_modules
2525
run: yarn
@@ -28,7 +28,6 @@ jobs:
2828
run: |
2929
git config --global user.name "${{ secrets.USER_NAME }}"
3030
git config --global user.email "${{ secrets.USER_EMAIL }}"
31-
3231
- name: Run pre-release script
3332
if: ${{ github.ref_name == 'dev' }}
3433
run: yarn run pre-release
@@ -43,4 +42,4 @@ jobs:
4342
github_token: ${{ secrets.USER_TOKEN }}
4443
branch: ${{ github.ref }}
4544
tags: true
46-
force: true
45+
force: true

‎.github/workflows/tag.yml

+14-29
Original file line numberDiff line numberDiff line change
@@ -17,40 +17,25 @@ jobs:
1717

1818
- uses: actions/setup-node@v2
1919
with:
20-
node-version: 14
20+
node-version: 16
2121

22-
- name: Install node_modules
23-
run: yarn
22+
- name: Install Antora and the Antora Lunr Extension
23+
run: npm i antora @antora/[email protected]
2424

2525
- name: Extract release data
2626
id: get-release-data
2727
run: |
2828
echo "::set-output name=tag::${GITHUB_REF##*/}"
2929
echo "::set-output name=file::${GITHUB_REPOSITORY#*/}-${GITHUB_REF##*/}"
3030
31-
- name: Build project
32-
run: yarn run build
33-
34-
- name: Zip artifacts
35-
run: zip -r ${{ steps.get-release-data.outputs.file }}.zip package.json README.md CHANGELOG.md build .docusaurus
36-
37-
- name: Create release
38-
uses: softprops/action-gh-release@v1
39-
with:
40-
token: ${{ secrets.USER_TOKEN }}
41-
tag_name: ${{ steps.get-release-data.outputs.tag }}
42-
prerelease: ${{ contains(steps.get-release-data.outputs.tag, '-') }}
43-
generate_release_notes: true
44-
draft: false
45-
files: |
46-
${{ steps.get-release-data.outputs.file }}.zip
47-
48-
- name: Deploy to GitHub Pages
49-
if: ${{ !contains(steps.get-release-data.outputs.tag, '-') }}
50-
uses: peaceiris/actions-gh-pages@v3
51-
with:
52-
github_token: ${{ secrets.USER_TOKEN }}
53-
publish_dir: ./build
54-
user_name: ${{ secrets.USER_NAME }}
55-
user_email: ${{ secrets.USER_EMAIL }}
56-
publish_branch: deployed
31+
# - name: Generate Site
32+
# run: npx antora playbook.yml
33+
34+
# - name: Deploy to GitHub Pages
35+
# if: ${{ !contains(steps.get-release-data.outputs.tag, '-') }}
36+
# uses: peaceiris/actions-gh-pages@v3
37+
# with:
38+
# github_token: ${{ secrets.USER_TOKEN }}
39+
# publish_dir: ./build
40+
# user_name: ${{ secrets.USER_NAME }}
41+
# user_email: ${{ secrets.USER_EMAIL }}

‎.gitignore

+2-9
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
22

33
# dependencies
4-
/node_modules
54
/.pnp
65
.pnp.js
76

87
# testing
98
/coverage
109

1110
# production
12-
/build
11+
#/build
12+
/public_html
1313

1414
# misc
1515
.idea
@@ -18,10 +18,3 @@
1818
.env.development.local
1919
.env.test.local
2020
.env.production.local
21-
22-
npm-debug.log*
23-
yarn-debug.log*
24-
yarn-error.log*
25-
*.log
26-
27-
.docusaurus

‎.htaccess

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
ErrorDocument 404 /404.html
2+
3+
# Code generated by www.301-redirect.online
4+
RewriteEngine on
5+
RewriteCond %{QUERY_STRING} ^$
6+
RewriteRule ^docs/$ /documentation? [R=301,L]
7+
8+
RewriteCond %{QUERY_STRING} ^$
9+
RewriteRule ^docs$ /documentation? [R=301,L]
10+
11+
RewriteCond %{QUERY_STRING} ^$
12+
RewriteRule ^docs/Blocks/header$ /documentation/develop/Blocks/header? [R=301,L]
13+
14+
RewriteCond %{QUERY_STRING} ^$
15+
RewriteRule ^docs/Blocks/header/index\.html$ /documentation/develop/Blocks/header? [R=301,L]
16+
17+
RewriteCond %{QUERY_STRING} ^$
18+
RewriteRule ^docs/Blocks/transaction\-life\-cycle$ /documentation/develop/Blocks/transaction-life-cycle? [R=301,L]
19+
20+
RewriteCond %{QUERY_STRING} ^$
21+
RewriteRule ^docs/Blocks/transaction\-life\-cycle/index\.html$ /documentation/develop/Blocks/transaction-life-cycle? [R=301,L]
22+
23+
RewriteCond %{QUERY_STRING} ^$
24+
RewriteRule ^docs/Blocks/transactions$ /documentation/develop/Blocks/transactions? [R=301,L]
25+
26+
RewriteCond %{QUERY_STRING} ^$
27+
RewriteRule ^docs/Blocks/transactions/index\.html$ /documentation/develop/Blocks/transactions? [R=301,L]
28+
29+
RewriteCond %{QUERY_STRING} ^$
30+
RewriteRule ^docs/CLI/commands$ /documentation/develop/CLI/commands? [R=301,L]
31+
32+
RewriteCond %{QUERY_STRING} ^$
33+
RewriteRule ^docs/CLI/commands/index\.html$ /documentation/develop/CLI/commands? [R=301,L]
34+
35+
RewriteCond %{QUERY_STRING} ^$
36+
RewriteRule ^docs/Contracts/contract\-abi$ /documentation/develop/Contracts/contract-abi? [R=301,L]
37+
38+
RewriteCond %{QUERY_STRING} ^$
39+
RewriteRule ^docs/Contracts/contract\-abi/index\.html$ /documentation/develop/Contracts/contract-abi? [R=301,L]
40+
41+
RewriteCond %{QUERY_STRING} ^$
42+
RewriteRule ^docs/Contracts/contract\-address$ /documentation/develop/Contracts/contract-address? [R=301,L]
43+
44+
RewriteCond %{QUERY_STRING} ^$
45+
RewriteRule ^docs/Contracts/contract\-address/index\.html$ /documentation/develop/Contracts/contract-address? [R=301,L]
46+
47+
RewriteCond %{QUERY_STRING} ^$
48+
RewriteRule ^docs/Contracts/contract\-classes$ /documentation/develop/Contracts/contract-classes? [R=301,L]
49+
50+
RewriteCond %{QUERY_STRING} ^$
51+
RewriteRule ^docs/Contracts/contract\-classes/index\.html$ /documentation/develop/Contracts/contract-classes? [R=301,L]
52+
53+
RewriteCond %{QUERY_STRING} ^$
54+
RewriteRule ^docs/Contracts/contract\-hash$ /documentation/develop/Contracts/contract-hash? [R=301,L]
55+
56+
RewriteCond %{QUERY_STRING} ^$
57+
RewriteRule ^docs/Contracts/contract\-hash/index\.html$ /documentation/develop/Contracts/contract-hash? [R=301,L]
58+
59+
RewriteCond %{QUERY_STRING} ^$
60+
RewriteRule ^docs/Contracts/contract\-storage$ /documentation/develop/Contracts/contract-storage? [R=301,L]
61+
62+
RewriteCond %{QUERY_STRING} ^$
63+
RewriteRule ^docs/Contracts/contract\-storage/index\.html$ /documentation/develop/Contracts/contract-storage? [R=301,L]
64+
65+
RewriteCond %{QUERY_STRING} ^$
66+
RewriteRule ^docs/Data\ Availabilty/on\-chain\-data$ /documentation/develop/Data_Availabilty/on-chain-data? [R=301,L]
67+
68+
RewriteCond %{QUERY_STRING} ^$
69+
RewriteRule ^docs/Data\ Availabilty/on\-chain\-data/index\.html$ /documentation/develop/Data_Availabilty/on-chain-data? [R=301,L]
70+
71+
RewriteCond %{QUERY_STRING} ^$
72+
RewriteRule ^docs/Events/starknet\-events$ /documentation/develop/Events/starknet-events? [R=301,L]
73+
74+
RewriteCond %{QUERY_STRING} ^$
75+
RewriteRule ^docs/Events/starknet\-events/index\.html$ /documentation/develop/Events/starknet-events? [R=301,L]
76+
77+
RewriteCond %{QUERY_STRING} ^$
78+
RewriteRule ^docs/Fees/fee\-mechanism$ /documentation/develop/Fees/fee-mechanism? [R=301,L]
79+
80+
RewriteCond %{QUERY_STRING} ^$
81+
RewriteRule ^docs/Fees/fee\-mechanism/index\.html$ /documentation/develop/Fees/fee-mechanism? [R=301,L]
82+
83+
RewriteCond %{QUERY_STRING} ^$
84+
RewriteRule ^docs/Hashing/hash\-functions$ /documentation/develop/Hashing/hash-functions? [R=301,L]
85+
86+
RewriteCond %{QUERY_STRING} ^$
87+
RewriteRule ^docs/Hashing/hash\-functions/index\.html$ /documentation/develop/Hashing/hash-functions? [R=301,L]
88+
89+
RewriteCond %{QUERY_STRING} ^$
90+
RewriteRule ^docs/intro$ /documentation? [R=301,L]
91+
92+
RewriteCond %{QUERY_STRING} ^$
93+
RewriteRule ^docs/intro/index\.html$ /documentation? [R=301,L]
94+
95+
RewriteCond %{QUERY_STRING} ^$
96+
RewriteRule ^docs/L1\-L2\ Communication/messaging\-mechanism$ /documentation/develop/L1-L2_Communication/messaging-mechanism? [R=301,L]
97+
98+
RewriteCond %{QUERY_STRING} ^$
99+
RewriteRule ^docs/L1\-L2\ Communication/messaging\-mechanism/index\.html$ /documentation/develop/L1-L2_Communication/messaging-mechanism? [R=301,L]
100+
101+
RewriteCond %{QUERY_STRING} ^$
102+
RewriteRule ^docs/L1\-L2\ Communication/token\-bridge$ /documentation/develop/L1-L2_Communication/token-bridge? [R=301,L]
103+
104+
RewriteCond %{QUERY_STRING} ^$
105+
RewriteRule ^docs/L1\-L2\ Communication/token\-bridge/index\.html$ /documentation/develop/L1-L2_Communication/token-bridge? [R=301,L]
106+
107+
RewriteCond %{QUERY_STRING} ^$
108+
RewriteRule ^docs/State/starknet\-state$ /documentation/develop/State/starknet-state? [R=301,L]
109+
110+
RewriteCond %{QUERY_STRING} ^$
111+
RewriteRule ^docs/State/starknet\-state/index\.html$ /documentation/develop/State/starknet-state? [R=301,L]

‎.prettierignore

-3
This file was deleted.

‎.prettierrc.json

-16
This file was deleted.

0 commit comments

Comments
 (0)