Skip to content

Commit ab3aa9f

Browse files
authored
Merge pull request #172 from dotnetprojects/codex/migrator-homepage
docs: add GitHub Pages homepage and expand project documentation
2 parents 02e8bf3 + d00e623 commit ab3aa9f

8 files changed

Lines changed: 1872 additions & 61 deletions

File tree

‎.github/workflows/pages.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Deploy homepage to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- "docs/**"
8+
- ".github/workflows/pages.yml"
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
14+
concurrency:
15+
group: github-pages
16+
cancel-in-progress: false
17+
18+
jobs:
19+
deploy:
20+
if: github.ref == 'refs/heads/master'
21+
runs-on: ubuntu-latest
22+
permissions:
23+
pages: write
24+
id-token: write
25+
environment:
26+
name: github-pages
27+
url: ${{ steps.deployment.outputs.page_url }}
28+
steps:
29+
- uses: actions/checkout@v6
30+
- uses: actions/configure-pages@v5
31+
- uses: actions/upload-pages-artifact@v4
32+
with:
33+
path: docs
34+
- name: Deploy homepage
35+
id: deployment
36+
uses: actions/deploy-pages@v4

‎README.md‎

Lines changed: 286 additions & 61 deletions
Large diffs are not rendered by default.

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/README.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Migrator.NET homepage
2+
3+
Static GitHub Pages site, with no build tools, external fonts or client-side dependencies. `index.html` contains the homepage, quick start and sourced framework comparison. Styling and progressive enhancements live in `assets/`.
4+
5+
## Preview
6+
7+
From the repository root:
8+
9+
```sh
10+
python -m http.server 8766 --directory docs --bind 127.0.0.1
11+
```
12+
13+
Open http://localhost:8766. Content and navigation work without JavaScript. Copy buttons require a secure context (HTTPS or localhost).
14+
15+
## Publish on GitHub Pages
16+
17+
1. In the repository's **Settings → Pages → Build and deployment**, set **Source** to **GitHub Actions**.
18+
2. Merge the site and `.github/workflows/pages.yml` into `master`.
19+
3. The workflow publishes only `docs/`. After enabling Pages, you can also run **Deploy homepage to GitHub Pages** manually on `master`.
20+
21+
Expected project URL: https://dotnetprojects.github.io/Migrator.NET/
22+
23+
All site assets use relative URLs, so the repository subpath works without a custom domain. No deployment or repository setting changes are performed by a local preview. GitHub may require an environment approval if the repository has deployment protection rules.
24+
25+
## Keep the comparison accurate
26+
27+
The comparison distinguishes source capabilities from guarantees about released packages or database compatibility. Update the review date and source links together when reviewing it. Avoid equating transaction rollback with reversing completed migrations, treating a provider enum as a support guarantee, or treating scoped history as a migration discovery filter.
28+
29+
The quick start targets the current source's .NET 9 API. Check the selected NuGet release's target frameworks. The SQLite driver version matches the repository test dependency. Validate authoring and runner snippets together when changing them.

‎docs/assets/favicon.svg‎

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)