Skip to content

Commit e9cc728

Browse files
committed
migrate learn to docs repo
1 parent 875ba66 commit e9cc728

File tree

226 files changed

+10883
-15216
lines changed

Some content is hidden

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

226 files changed

+10883
-15216
lines changed

.github/CODEOWNERS

Lines changed: 0 additions & 1 deletion
This file was deleted.

.gitignore

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1-
node_modules
2-
docs/.vitepress/dist
3-
.DS_STORE
1+
# Dependencies
2+
node_modules/
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus/
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env
14+
.env.local
15+
.env.development.local
16+
.env.test.local
17+
.env.production.local
18+
19+
npm-debug.log*
20+
yarn-debug.log*
21+
yarn-error.log*
22+
23+
# Local Netlify folder
24+
.netlify
25+
.vscode/settings.json
26+
/.idea/

.nvmrc

Lines changed: 0 additions & 1 deletion
This file was deleted.

LICENSE

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright 2022 Illusory Systems Inc.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,21 @@
1-
# Documentation Site
1+
# Nomad Docs
22

3-
## Install
43

5-
```sh
6-
npm install
7-
```
4+
## Development
85

9-
## Build
6+
- You will need `docusaurus` and `node 16` to develop and test locally the documentation website
7+
- [Install Docusaurus](https://docusaurus.io/docs/installation)
8+
- `git clone` the repository locally
9+
- Run `yarn` or `npm install` from inside the repository to install all dependencies
10+
- `yarn start`: Will start a local dev server that will automatically reload with every change to the source code
11+
- Please use named or forked branches. All changes should be PRed to `dev` and if everything works as expected, only then `dev` should be merged into `main`
1012

11-
```sh
12-
npm run docs:build
13-
```
13+
## Deployment
1414

15-
## Serve Dev Environment
15+
- The docs are automatically deployed from the github repo via Netlify
16+
- `main` is deployed to `docs.nomad.xyz`
17+
- `dev` is deployed to `dev.docs.nomad.xyz`
1618

17-
```sh
18-
npm run docs:dev
19-
```
19+
## License
2020

21-
## Serve Prod Environment
22-
23-
```sh
24-
npm run docs:serve
25-
```
21+
Apache License 2.0

babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

docs/.vitepress/config.js

Lines changed: 0 additions & 94 deletions
This file was deleted.

docs/.vitepress/theme/custom.css

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/.vitepress/theme/index.js

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/agents/overview.md

Whitespace-only changes.

docs/agents/processor.md

Whitespace-only changes.

docs/agents/relayer.md

Whitespace-only changes.

docs/agents/updater.md

Whitespace-only changes.

docs/agents/watcher.md

Whitespace-only changes.

docs/brand-kit.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/bridge/domains-testnet.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/bridge/domains.md

Lines changed: 0 additions & 119 deletions
This file was deleted.

docs/bridge/etherscan-native.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)