Skip to content

Commit 82a7aee

Browse files
Adjust docs more for public.
1 parent 7517e6e commit 82a7aee

19 files changed

Lines changed: 29 additions & 66 deletions

.cursor/agents/docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ gbx:docs:restart
113113

114114
### Scenario 5: Build offline zip for distribution
115115
```bash
116-
# Build with relative paths and create zip for resources/beta-dist/
116+
# Build with relative paths and create zip for offline distribution (e.g. --output ./docs-build)
117117
gbx:docs:static-build
118118

119119
# Zip is written to resources/static/geobrix-docs-<version>.zip (version from docs/package.json)

.cursor/commands/gbx-docs-static-build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Docs Static Build (Offline Zip)
22

3-
Build the documentation with relative paths and optionally create a zip for offline/local viewing (e.g. for `resources/beta-dist/`).
3+
Build the documentation with relative paths and optionally create a zip for offline/local viewing.
44

55
## Usage
66

@@ -28,7 +28,7 @@ bash .cursor/commands/gbx-docs-static-build.sh [OPTIONS]
2828
bash .cursor/commands/gbx-docs-static-build.sh
2929

3030
# Zip to a custom folder
31-
bash .cursor/commands/gbx-docs-static-build.sh --output resources/beta-dist/v0.2.0 # or any path; zip name still uses version from docs/package.json
31+
bash .cursor/commands/gbx-docs-static-build.sh --output ./docs-build # or any path; zip name uses version from docs/package.json
3232

3333
# Build only (no zip)
3434
bash .cursor/commands/gbx-docs-static-build.sh --skip-zip

.cursor/commands/gbx-docs-static-build.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/bin/bash
2-
# gbx:docs:static-build - Build docs for static zip (relative paths) and optionally zip to resources/beta-dist
2+
# gbx:docs:static-build - Build docs for static zip (relative paths) and optionally zip for offline distribution
33

44
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
55
PROJECT_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
@@ -30,7 +30,7 @@ EXAMPLES:
3030
bash .cursor/commands/gbx-docs-static-build.sh
3131
3232
# Zip to a custom folder (zip name still uses version from docs/package.json)
33-
bash .cursor/commands/gbx-docs-static-build.sh --output resources/beta-dist/v0.2.0
33+
bash .cursor/commands/gbx-docs-static-build.sh --output ./docs-build
3434
3535
# Build only (no zip)
3636
bash .cursor/commands/gbx-docs-static-build.sh --skip-zip

.github/CODECOV.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The README Codecov badge is:
66

7-
- **Badge image:** `https://codecov.io/gh/databrickslabs/geobrix/branch/main/graph/badge.svg`
7+
- **Badge image:** `https://codecov.io/gh/databrickslabs/geobrix/branch/master/graph/badge.svg`
88
- **Project page:** https://codecov.io/gh/databrickslabs/geobrix
99

1010
The badge updates when Codecov receives a new coverage upload for this repo. This repo is public, so the default badge works.

.github/workflows/build_main.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: build main
22
# Runs on: push to any branch (except python/** and scala/**), all PRs, and manual trigger.
3-
# Scala doc tests are excluded from the main Scala run; they run in a separate step only on push to main.
3+
# Scala doc tests are excluded from the main Scala run; they run in a separate step only on push to master.
44
# Manual run: Actions → "build main" → Run workflow (workflow_dispatch).
55
#
66
# Use runs-on: larger for all jobs (ubuntu-latest gets 403 on actions/checkout for private repo).
@@ -17,10 +17,10 @@ permissions:
1717
contents: read
1818
id-token: write
1919
jobs:
20-
# Regenerate doc-snippet-inventory and push to the PR branch (not main). Only for PRs targeting main.
20+
# Regenerate doc-snippet-inventory and push to the PR branch (not master). Only for PRs targeting master.
2121
update-doc-inventory:
2222
runs-on: larger
23-
if: github.event_name == 'pull_request' && github.base_ref == 'main'
23+
if: github.event_name == 'pull_request' && github.base_ref == 'master'
2424
permissions:
2525
contents: write
2626
steps:
@@ -68,16 +68,16 @@ jobs:
6868
with:
6969
# Disable scoverage in main build to keep CI ~10–15 min (full Scala coverage is ~30+ min). Run "Upload coverage to Codecov" workflow manually for Scala+Python coverage.
7070
enable_coverage: "false"
71-
fail_on_scalastyle: ${{ github.event_name == 'pull_request' && github.base_ref == 'main' }}
71+
fail_on_scalastyle: ${{ github.event_name == 'pull_request' && github.base_ref == 'master' }}
7272
- name: build python
7373
uses: ./.github/actions/python_build
7474
with:
75-
run_lint: ${{ github.event_name == 'pull_request' && github.base_ref == 'main' }}
75+
run_lint: ${{ github.event_name == 'pull_request' && github.base_ref == 'master' }}
7676
enable_coverage: "true"
7777
- name: Rebuild doc-snippet-inventory
7878
run: python3 scripts/ci/inventory-doc-snippets.py
7979
# Disabled until project launch. Re-enable by restoring the condition below.
80-
- name: Scala doc tests (main only, after everything else)
80+
- name: Scala doc tests (master only, after everything else)
8181
if: false # Disabled until project launch
8282
env:
8383
GBX_SAMPLE_DATA_ROOT: ${{ runner.temp }}/geobrix-sample-data

.github/workflows/codecov-upload.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# Requirements:
88
# - Repo secret CODECOV_TOKEN (from https://codecov.io/gh/databrickslabs/geobrix → Settings).
99
#
10-
# Badge: README uses https://codecov.io/gh/databrickslabs/geobrix/branch/main/graph/badge.svg
10+
# Badge: README uses https://codecov.io/gh/databrickslabs/geobrix/branch/master/graph/badge.svg
1111

1212
name: Upload coverage to Codecov
1313

.github/workflows/codeql-analysis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ name: "CodeQL"
22

33
on:
44
push:
5-
branches: [ "main" ]
5+
branches: [ "master" ]
66
pull_request:
77
# The branches below must be a subset of the branches above
8-
branches: [ "main" ]
8+
branches: [ "master" ]
99
schedule:
1010
- cron: '18 16 * * 0'
1111
workflow_dispatch:

.github/workflows/deploy-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ name: Deploy documentation
1010

1111
on:
1212
push:
13-
branches: [main]
13+
branches: [master]
1414
paths:
1515
- 'docs/**'
1616
- '.github/workflows/deploy-docs.yml'

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<img src="resources/images/GeoBriX.png" width="50%" />
22

33
[![build](https://github.com/databrickslabs/geobrix/actions/workflows/build_main.yml/badge.svg)](https://github.com/databrickslabs/geobrix/actions/workflows/build_main.yml)
4-
[![codecov](https://codecov.io/gh/databrickslabs/geobrix/branch/main/graph/badge.svg)](https://codecov.io/gh/databrickslabs/geobrix)
4+
[![codecov](https://codecov.io/gh/databrickslabs/geobrix/branch/master/graph/badge.svg)](https://codecov.io/gh/databrickslabs/geobrix)
55
[![docs](https://github.com/databrickslabs/geobrix/actions/workflows/doc-tests.yml/badge.svg)](https://github.com/databrickslabs/geobrix/actions/workflows/doc-tests.yml)
66
[![documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://databrickslabs.github.io/geobrix/)
77
[![scala](https://img.shields.io/badge/scala-2.13-red.svg)](https://www.scala-lang.org/)

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This command generates static content into the `build` directory and can be serv
3434

3535
### GitHub Actions (recommended)
3636

37-
Docs are built and deployed automatically by the [Deploy documentation](https://github.com/databrickslabs/geobrix/actions/workflows/deploy-docs.yml) workflow when you push to `main` (under `docs/`) or run it manually.
37+
Docs are built and deployed automatically by the [Deploy documentation](https://github.com/databrickslabs/geobrix/actions/workflows/deploy-docs.yml) workflow when you push to `master` (under `docs/`) or run it manually.
3838

3939
**One-time setup:** In the repo go to **Settings → Pages**. Under **Build and deployment**, set **Source** to **GitHub Actions**. The site will be published at **https://databrickslabs.github.io/geobrix/**.
4040

0 commit comments

Comments
 (0)