Skip to content

Add GitHub Pages documentation site - #37

Merged
LeonardoBai12 merged 12 commits into
mainfrom
lbai/feat/github-pages-docs
Jun 22, 2026
Merged

LeonardoBai12 merged 12 commits into
mainfrom
lbai/feat/github-pages-docs

Conversation

@LeonardoBai12

Copy link
Copy Markdown
Owner

Summary

  • Jekyll + Chirpy documentation site under documentation/ folder, matching the AdvancedKotlinAndroidEngineering setup
  • GitHub Actions workflow that generates KDoc via Dokka, builds Jekyll, copies KDoc into the site, and deploys to GitHub Pages
  • New pages: Ecosystem (MiddlewarePlayground + MIddlewareUserService) and About the Creator
  • Updated README to point to the new site instead of GitBook and local .md files
  • Removed redundant documentation_workflow.yml (superseded by the Pages workflow)
  • Added Jekyll build artifacts and local vendor gems to .gitignore

Test plan

  • Enable GitHub Pages in repo Settings → Pages → Source → GitHub Actions
  • Verify site deploys at https://leonardobai12.github.io/ProjectMiddleware/ after merge
  • Check avatar renders correctly in sidebar (3x zoom, centered)
  • Check Ecosystem and About pages render with images
  • Check KDoc is accessible at /kdoc/

🤖 Generated with Claude Code

LeonardoBai12 and others added 11 commits June 22, 2026 17:48
Jekyll site (Chirpy theme) built from documentation/ folder with the
same sidebar template as AdvancedKotlinAndroidEngineering. KDoc is
generated from source on every push to main via Dokka and copied into
_site/kdoc/ before deployment, keeping the API reference always current.

Pages covered: home, how it works, key features, mapping rules, mapping
request (including X-Mapped-Auth), preview route, endpoints overview,
Postman collection, and KDoc reference.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add About the Creator page with profile photo, experience, education, and project links
- Add Ecosystem page covering MiddlewarePlayground and MIddlewareUserService with architecture diagram
- Update navigation to include Ecosystem and About sections
- Fix avatar path in _config.yml to use middleware-icon.jpg
- Add Jekyll-specific entries (.jekyll-cache, _site) to .gitignore

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Local bundler gem cache should not be committed.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace GitBook and local MD file links with the new
leonardobai12.github.io/ProjectMiddleware site.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace GitBook and local .md links with leonardobai12.github.io/ProjectMiddleware
while keeping all original explanations and structure intact.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Merge duplicate How It Works / Steps sections into one flow
- Replace verbose endpoint bullets with a table; fix /v1/preview method (POST not GET)
- Tighten key features to remove redundancy
- Clean up Postman section heading

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@LeonardoBai12 LeonardoBai12 self-assigned this Jun 22, 2026
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@LeonardoBai12
LeonardoBai12 merged commit 7370ed6 into main Jun 22, 2026
2 checks passed
@LeonardoBai12
LeonardoBai12 deleted the lbai/feat/github-pages-docs branch June 22, 2026 21:34
@LeonardoBai12
LeonardoBai12 restored the lbai/feat/github-pages-docs branch June 23, 2026 04:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant