Skip to content

Commit 7cba9ad

Browse files
author
Mike Diarmid
authored
refactor: Prepare docs for OSS (invertase#2)
1 parent 2315370 commit 7cba9ad

36 files changed

+1067
-1
lines changed

‎.github/.cspell/dart_dictionary.txt‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Keywords/terms specific to the Dart/Flutter ecosystem
2+
dartdoc
3+
pubspec
4+
unawaited
5+
endtemplate
6+
gitignores
7+
writeln
8+
Stderrs

‎.github/.cspell/globe_dictionary.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Dictionary file for Globe-related words
2+
Redeployments
3+
Jaspr
4+
globeapp
5+
Dammam
6+
Querétaro

‎.github/.cspell/people_usernames.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Specific people's names and/or usernames
2+
rroussel
3+
subosito
4+
bluefireteam
5+
thollander
6+
amannn

‎.github/.cspell/words_dictionary.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Actual english words (or common abbreviations) missing from CSpell
2+
upvote

‎.github/cspell.json‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"version": "0.2",
3+
"language": "en",
4+
"flagWords": ["teh", "hte"],
5+
"ignorePaths": [".github/**", "**/CHANGELOG.md"],
6+
"ignoreRegExpList": ["\\#[\\w\\-]+"],
7+
"dictionaries": [
8+
"en_US",
9+
"softwareTerms",
10+
"dart_dictionary",
11+
"globe_dictionary",
12+
"people_usernames",
13+
"words_dictionary"
14+
],
15+
"dictionaryDefinitions": [
16+
{
17+
"name": "dart_dictionary",
18+
"path": "./.github/.cspell/dart_dictionary.txt",
19+
"addWords": true
20+
},
21+
{
22+
"name": "globe_dictionary",
23+
"path": "./.github/.cspell/globe_dictionary.txt",
24+
"addWords": true
25+
},
26+
{
27+
"name": "usernames",
28+
"path": "./.github/.cspell/people_usernames.txt",
29+
"addWords": true
30+
},
31+
{
32+
"name": "words_dictionary",
33+
"path": "./.github/.cspell/words_dictionary.txt",
34+
"addWords": true
35+
}
36+
]
37+
}

‎.github/workflows/dart_validate.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@ name: all_dart_packages
22

33
on:
44
pull_request:
5+
paths-ignore:
6+
- 'docs/**'
57
push:
8+
paths-ignore:
9+
- 'docs/**'
610
branches:
711
- main
812

‎.github/workflows/docs_comment.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: docs_preview
2+
on:
3+
pull_request:
4+
paths:
5+
- "docs/**"
6+
- "docs.yaml"
7+
types: [opened]
8+
9+
jobs:
10+
comment_link:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v3
15+
- name: Comment PR
16+
uses: thollander/actions-comment-pull-request@v2
17+
with:
18+
# pr number
19+
message: |
20+
:books: Documentation changes in this PR can be previewed [here](https://docs.page/invertase/globe~${{ github.event.pull_request.number }}).

‎.github/workflows/spell_checker.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: spell_checker
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
jobs:
10+
check:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: streetsidesoftware/cspell-action@v5
15+
with:
16+
config: ".github/cspell.json"
17+
files: "**/*.{md,mdx,dart}"

‎.github/workflows/title_validation.yaml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
name: "PR Title is Conventional"
22

33
on:
4-
pull_request:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- edited
8+
- synchronize
59

610
jobs:
711
main:

‎docs.yaml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
name: Docs
3+
logo: "/assets/globe_dark.png"
4+
logoDark: "/assets/globe_light.png"
5+
twitter: dart_globe
6+
anchors:
7+
- title: Discord
8+
icon: discord
9+
link: https://invertase.link/globe-discord
10+
theme: "#FFA03F"
11+
favicon: "/assets/globe_dark.png"
12+
sidebar:
13+
- - Overview
14+
- "/"
15+
- - Getting Started
16+
- "/getting-started"
17+
- - CLI
18+
- - - CLI Overview
19+
- "/cli"
20+
- - Deploy
21+
- "/cli.commands.deploy"
22+
- - Link
23+
- "/cli.commands.link"
24+
- - Login
25+
- "/cli.commands.login"
26+
- - Logout
27+
- "/cli.commands.logout"
28+
- - Unlink
29+
- "/cli.commands.unlink"
30+
- - Deployments
31+
- - - Overview
32+
- "/deployments"
33+
- - Build Settings
34+
- "/deployments.build-settings"
35+
- - Domains
36+
- "/deployments.domains"
37+
- - Environment Variables
38+
- "/deployments.environment-variables"
39+
- - GitHub Integration
40+
- "/deployments.github-integration"
41+
- - Hooks
42+
- "/deployments.hooks"
43+
- - Redeployments
44+
- "/deployments.redeployments"
45+
- - Frameworks
46+
- - - Overview
47+
- "/frameworks"
48+
- - Dart Frog
49+
- "/frameworks.dart-frog"
50+
- - Jaspr
51+
- "/frameworks.jaspr"
52+
- - Infrastructure
53+
- - - Overview
54+
- "/infrastructure"
55+
- - Cold Starts
56+
- "/infrastructure.cold-starts"
57+
- - Cron Jobs
58+
- "/infrastructure.cron-jobs"
59+
- - Headers
60+
- "/infrastructure.headers"
61+
- - Regions
62+
- "/infrastructure.regions"
63+
- - WebSockets
64+
- "/infrastructure.websockets"

0 commit comments

Comments
 (0)