Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: revive gear.rs as a place for internal docs #1

Merged
merged 3 commits into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
groups:
deps:
patterns:
- "*"
38 changes: 26 additions & 12 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,30 +1,44 @@
name: Publish

on:
pull_request:
branches: [master]
push:
branches: [master]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

permissions:
contents: read
id-token: write
pages: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Setup mdBook
uses: peaceiris/actions-mdbook@v1
with:
mdbook-version: "0.4.12"
mdbook-version: "0.4.35"

- name: Build docs
run: mdbook build

- run: mdbook build
- name: Setup GitHub Pages
if: github.event_name == 'push'
uses: actions/configure-pages@v3

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
- name: Upload Pages artifact
if: github.event_name == 'push'
uses: actions/upload-pages-artifact@v2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./book
cname: gear.rs
force_orphan: true
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
path: book

- name: Deploy to GitHub Pages
if: github.event_name == 'push'
uses: actions/deploy-pages@v2
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ all:
@mdbook build

prepare:
@cargo install mdbook --vers "0.4.12"
@cargo install mdbook --vers "0.4.35"

serve:
@mdbook serve
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Gear for Rustaceans

[![Publish Status](https://github.com/gear-tech/gear.rs/workflows/Publish/badge.svg)](https://github.com/gear-tech/gear.rs/actions/workflows/publish.yml?query=branch%3Amaster)
[![Publish Status](https://github.com/gear-tech/gear-tech.github.io/workflows/Publish/badge.svg)](https://github.com/gear-tech/gear.rs/actions/workflows/publish.yml?query=branch%3Amaster)

Gear projects navigator for Rust developers.

Expand All @@ -13,8 +13,8 @@ Gear projects navigator for Rust developers.
1. Clone:

```bash
git clone https://github.com/gear-tech/gear.rs.git
cd gear.rs
git clone https://github.com/gear-tech/gear-tech.github.io.git
cd gear-tech.github.io
```

2. Install [mdBook](https://github.com/rust-lang/mdBook):
Expand Down
8 changes: 4 additions & 4 deletions book.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[book]
authors = ["Gear Technologies"]
language = "en"
multilingual = false
src = "src"
title = "Gear for Rustaceans"
authors = ["Gear Technologies"]

[output.html]
git-repository-url = "https://github.com/gear-tech/gear-tech.github.io"
2 changes: 1 addition & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Summary

[Introduction](./introduction.md)
[Introduction](introduction.md)
14 changes: 3 additions & 11 deletions src/introduction.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
# Introduction

Here we collect the information helping Rust developers to hack the Gear node, develop Gear smart contracts (a.k.a. programs), etc.
Here we collect the information helping Rust developers deal with the Gear protocol internals.

## Crate Docs
## Disclaimer

The stable crate docs will be posted on [docs.rs](https://docs.rs/) after the Gear crates are published. The latest docs are currently at [docs.gear.rs](https://docs.gear.rs/):

* **gear-core**: [https://docs.gear.rs/gear_core](https://docs.gear.rs/gear_core/)

Gear engine for distributed computing core components.

* **gstd**: [https://docs.gear.rs/gstd](https://docs.gear.rs/gstd/)

Standard library for Gear smart contracts.
The information provided here is not a part of the official documentation and is not guaranteed to be up-to-date. It is provided as-is and is not covered by any support. Use it at your own risk.
Loading