Skip to content

Add docsify documentation site under docs/ with multi-language examples#972

Draft
philihp wants to merge 1 commit into
mainfrom
claude/add-docs-site-7GzwB
Draft

Add docsify documentation site under docs/ with multi-language examples#972
philihp wants to merge 1 commit into
mainfrom
claude/add-docs-site-7GzwB

Conversation

@philihp
Copy link
Copy Markdown
Owner

@philihp philihp commented May 10, 2026

Summary

  • Adds a docs/ folder containing a docsify static site (no build step — markdown is rendered client-side from CDN).
  • Site covers Getting Started, full API Reference, Models, Predictions, and Ranking guides.
  • Adds an Examples by Language section with idiomatic usage for every known port: JavaScript/TypeScript, Python, Java, Kotlin, Elixir, Lua, and Google Apps Script.
  • Adds .github/workflows/docs.yml to publish docs/ to GitHub Pages on pushes to main.
  • Links the new docs site from the top of README.md.

Layout

docs/
  index.html              docsify entrypoint (Vue theme, search, copy-code, pagination)
  .nojekyll               disable Jekyll on Pages
  README.md               home
  _coverpage.md           cover page
  _navbar.md / _sidebar.md
  getting-started.md
  api.md
  models.md
  predictions.md
  ranking.md
  examples/
    javascript.md
    python.md
    java.md
    kotlin.md
    elixir.md
    lua.md
    google-apps-script.md

To enable GitHub Pages

After merge, enable Pages in Settings → Pages → Source: GitHub Actions. The workflow in .github/workflows/docs.yml will then publish to https://philihp.github.io/openskill.js/.

Test plan

  • Local preview: npx docsify-cli serve docs and click through every sidebar entry.
  • Verify code blocks for each language render with syntax highlighting (Prism components for js/ts/python/java/kotlin/elixir/lua are loaded in index.html).
  • After merging, enable Pages → GitHub Actions and confirm the workflow deploys successfully.

https://claude.ai/code/session_01Tt5sD8EAVhxBXtVLkiXSrW


Generated by Claude Code

Builds a static GitHub Pages site from the docs/ folder using docsify
(no build step). Includes API reference, model and prediction guides,
and idiomatic usage examples for each language port: JavaScript,
Python, Java, Kotlin, Elixir, Lua, and Google Apps Script.

Adds a Pages deploy workflow that publishes docs/ on changes to main.

https://claude.ai/code/session_01Tt5sD8EAVhxBXtVLkiXSrW
@coveralls
Copy link
Copy Markdown

Coverage Status

coverage: 100.0%. remained the same — claude/add-docs-site-7GzwB into main

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.

3 participants