docs: add GitHub Pages homepage and expand project documentation - #172
Merged
Merged
Conversation
Create a responsive static homepage for DotNetProjects.Migrator with a C# migration example, installation guide, provider inventory, project links, accessible navigation, and progressive copy-to-clipboard controls. Compare Migrator with FluentMigrator, EF Core, DbUp, and Evolve using official documentation and repository implementation evidence. Cover authoring, ORM coupling, model scaffolding, raw SQL, downgrade behavior, history separation, transactions, execution, providers, and recurring work. Include dated sources and distinguish provider availability from compatibility guarantees and transaction rollback from migration reversal. Replace the outdated README with NuGet/build/Pages/framework/license badges, runnable SQLite examples, runner API guidance, migration scope semantics, provider mappings, build and test instructions, contribution guidance, and links to the homepage and comparison. Add a GitHub Actions workflow that publishes docs/ to GitHub Pages on relevant master changes or manual dispatch. Document initial Pages setup and local preview commands. Site assets use relative paths and require no build tools or client-side dependencies. Validation: - Compiled and exercised the documented SQLite snippets against the current source: create, repeated execution, downgrade, and reapply. - Passed all 19 focused migration runner tests. - Checked desktop/mobile layouts, citation disclosure, and copy controls. - Verified local documentation links, HTML anchors, and asset paths. - Passed JavaScript syntax and git whitespace checks. Publishing still requires these changes on master and GitHub Actions selected as the repository's Pages source.
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Fix the Pages checkout permission and the two documentation issues before approval.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 1
Open (2)
What changed in this PR
Adds a static GitHub Pages homepage and expands Migrator documentation with examples, provider details, comparisons, and publishing automation.
Changes:
- Adds responsive HTML, CSS, JavaScript, favicon, and Pages configuration.
- Expands README and docs with SQLite examples, API guidance, providers, testing, and comparisons.
- Adds automated GitHub Pages deployment for
docs/.
| File | Summary | Findings |
|---|---|---|
README.md |
Expanded project documentation and examples | Nit (1 vote): package links point to unpacked paths. |
docs/README.md |
Added preview and publishing instructions | Nit (3 votes): setup arrow is mojibake. |
docs/index.html |
Added homepage and framework comparison | None |
docs/assets/site.js |
Added copy and citation enhancements | None |
docs/assets/site.css |
Added responsive styling | None |
docs/assets/favicon.svg |
Added site favicon | None |
docs/.nojekyll |
Enables static Pages deployment | None |
.github/workflows/pages.yml |
Publishes docs/ to GitHub Pages |
Critical (3 votes): missing contents: read prevents checkout. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+22
to
+24
| permissions: | ||
| pages: write | ||
| id-token: write |
|
|
||
| ## Publish on GitHub Pages | ||
|
|
||
| 1. In the repository's **Settings → Pages → Build and deployment**, set **Source** to **GitHub Actions**. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Create a responsive static homepage for DotNetProjects.Migrator with a C# migration example, installation guide, provider inventory, project links, accessible navigation, and progressive copy-to-clipboard controls.
Compare Migrator with FluentMigrator, EF Core, DbUp, and Evolve using official documentation and repository implementation evidence. Cover authoring, ORM coupling, model scaffolding, raw SQL, downgrade behavior, history separation, transactions, execution, providers, and recurring work. Include dated sources and distinguish provider availability from compatibility guarantees and transaction rollback from migration reversal.
Replace the outdated README with NuGet/build/Pages/framework/license badges, runnable SQLite examples, runner API guidance, migration scope semantics, provider mappings, build and test instructions, contribution guidance, and links to the homepage and comparison.
Add a GitHub Actions workflow that publishes docs/ to GitHub Pages on relevant master changes or manual dispatch. Document initial Pages setup and local preview commands. Site assets use relative paths and require no build tools or client-side dependencies.
Validation:
Publishing still requires these changes on master and GitHub Actions selected as the repository's Pages source.