Skip to content
This repository was archived by the owner on Jun 18, 2026. It is now read-only.

Commit b1472f0

Browse files
sauravbhattacharya001sauravbhattacharya001
committed
docs: add comprehensive multi-page documentation site
- Create 5-page docs site with shared CSS and sidebar navigation - index.html: Landing page with overview, features, quick start - guide.html: Complete setup guide (Maven, Ant, Docker, testing) - architecture.html: Project structure, data pipeline, algorithms - database.html: PostgreSQL schema reference (from DATABASE.md) - api.html: Full API reference for all public classes/methods - styles.css: Shared dark-mode design system with responsive layout - Update pages.yml to generate Javadoc during CI and include in site - Split workflow into build (JDK + Javadoc) and deploy jobs - Link to Javadoc from sidebar navigation
1 parent 0743a85 commit b1472f0

7 files changed

Lines changed: 2000 additions & 561 deletions

File tree

‎.github/workflows/pages.yml‎

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
name: Deploy to GitHub Pages
1+
name: Deploy Documentation
22

33
on:
44
push:
55
branches: [master]
66
paths:
77
- 'docs/**'
8+
- 'Gvisual/src/**'
9+
- 'pom.xml'
810
- '.github/workflows/pages.yml'
911
workflow_dispatch:
1012

@@ -18,14 +20,32 @@ concurrency:
1820
cancel-in-progress: true
1921

2022
jobs:
21-
deploy:
23+
build:
2224
runs-on: ubuntu-latest
23-
environment:
24-
name: github-pages
25-
url: ${{ steps.deployment.outputs.page_url }}
2625
steps:
2726
- name: Checkout
28-
uses: actions/checkout@v6
27+
uses: actions/checkout@v4
28+
29+
- name: Set up JDK 11
30+
uses: actions/setup-java@v4
31+
with:
32+
java-version: '11'
33+
distribution: 'temurin'
34+
35+
- name: Install local dependencies
36+
run: mvn initialize -P install-local-deps -B
37+
38+
- name: Generate Javadoc
39+
run: mvn javadoc:javadoc -B -Dmaven.javadoc.failOnError=false
40+
41+
- name: Copy Javadoc to docs site
42+
run: |
43+
mkdir -p docs/javadoc
44+
if [ -d "target/site/apidocs" ]; then
45+
cp -r target/site/apidocs/* docs/javadoc/
46+
else
47+
echo '<html><body><h1>Javadoc</h1><p>Javadoc generation pending. Build locally with <code>mvn javadoc:javadoc</code>.</p></body></html>' > docs/javadoc/index.html
48+
fi
2949
3050
- name: Setup Pages
3151
uses: actions/configure-pages@v5
@@ -35,6 +55,13 @@ jobs:
3555
with:
3656
path: docs
3757

58+
deploy:
59+
needs: build
60+
runs-on: ubuntu-latest
61+
environment:
62+
name: github-pages
63+
url: ${{ steps.deployment.outputs.page_url }}
64+
steps:
3865
- name: Deploy to GitHub Pages
3966
id: deployment
4067
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)