Skip to content

refactor: restructure docs/ and site/ directories#43

Merged
pavelanni merged 2 commits into
mainfrom
refactor/restructure-docs-site
May 6, 2026
Merged

refactor: restructure docs/ and site/ directories#43
pavelanni merged 2 commits into
mainfrom
refactor/restructure-docs-site

Conversation

@pavelanni
Copy link
Copy Markdown
Collaborator

@pavelanni pavelanni commented May 6, 2026

Summary

  • site/ — GitHub Pages content (HTML pages, CNAME, compiled slides, llms.txt)
  • docs/ — All documentation (design, research, slide .md sources)
  • docs/dev/ — Absorbs former top-level dev/ (plans, specs)
  • Adds GitHub Actions workflow to deploy Pages from site/ (since GH Pages only supports / or /docs as static source)
  • Pages build type already switched to workflow via API

Closes #41

Test plan

  • Verify GitHub Pages site loads correctly after merge
  • Verify Pages workflow runs successfully
  • Check slide links work from the site

Assisted-By: Claude (Anthropic AI) noreply@anthropic.com

Summary by CodeRabbit

  • New Features

    • Added a Demo button to the website navigation.
  • Chores

    • Configured GitHub Pages deployment workflow for automated site hosting.

Separate GitHub Pages content from documentation:
- site/ for published HTML (CNAME, pages, slides, llms.txt)
- docs/ for all documentation (design, research, slide sources)
- docs/dev/ absorbs former top-level dev/ (plans, specs)
- Add GitHub Actions workflow to deploy Pages from site/
- Update CLAUDE.md project structure table

Closes #41

Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com>
Signed-off-by: Pavel Anni <panni@redhat.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: 5133e622-4dfd-4b69-8996-80682e30648c

📥 Commits

Reviewing files that changed from the base of the PR and between 6f5f7ef and ccf505c.

📒 Files selected for processing (30)
  • .github/workflows/pages.yaml
  • CLAUDE.md
  • docs/dev/plans/2026-04-16-skillctl-mvp.md
  • docs/dev/plans/2026-04-20-catalog-metadata-annotations.md
  • docs/dev/plans/2026-04-24-phase2a-catalog-server.md
  • docs/dev/plans/2026-04-27-skill-collections.md
  • docs/dev/plans/2026-04-29-remote-git-sources.md
  • docs/dev/plans/2026-04-30-installed-skills-listing.md
  • docs/dev/plans/2026-04-30-rm-delete-command.md
  • docs/dev/plans/2026-04-30-upgrade-command.md
  • docs/dev/plans/2026-05-01-collection-install-git-sources.md
  • docs/dev/plans/2026-05-01-list-output-formatting.md
  • docs/dev/specs/2026-04-20-catalog-metadata-annotations-design.md
  • docs/dev/specs/2026-04-24-phase2a-catalog-server-design.md
  • docs/dev/specs/2026-04-27-skill-collections-design.md
  • docs/dev/specs/2026-04-29-remote-git-sources-design.md
  • docs/dev/specs/2026-04-30-installed-skills-listing-design.md
  • docs/dev/specs/2026-04-30-rm-delete-command-design.md
  • docs/dev/specs/2026-04-30-upgrade-command-design.md
  • docs/dev/specs/2026-05-01-collection-install-git-sources-design.md
  • docs/dev/specs/2026-05-01-list-output-formatting-design.md
  • site/CNAME
  • site/demo/index.html
  • site/examples.html
  • site/index.html
  • site/llms-full.txt
  • site/llms.txt
  • site/slides/index.html
  • site/slides/oci-skill-distribution-deck.html
  • site/slides/skillimage-deck.html

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting


📝 Walkthrough

Walkthrough

This PR introduces GitHub Pages deployment infrastructure, updates the project structure documentation, and adds development planning documents for two upcoming features: Git source support for collection installation and list output formatting improvements.

Changes

GitHub Pages Deployment

Layer / File(s) Summary
CI/CD Workflow
.github/workflows/pages.yaml
New workflow triggers on pushes to main affecting site/** and manual dispatch, with permissions and concurrency rules for safe page deployment.
Site Content
site/index.html
Demo button added to hero section between Examples and Presentations.

Development Documentation Structure and Planning

Layer / File(s) Summary
Project Structure
CLAUDE.md
Project structure table updated to reflect new organization: site/ for GitHub Pages content, docs/ for all documentation, and docs/dev/ for internal plans and specs.
Collection Install Feature Plan
docs/dev/plans/2026-05-01-collection-install-git-sources.md
Comprehensive plan detailing Git source support addition to collection install, including SkillRef struct extension, validation rules, LsRemote functionality, CLI wiring, and full install flow with provenance handling.
Collection Install Feature Spec
docs/dev/specs/2026-05-01-collection-install-git-sources-design.md
Design specification for collection install with Git sources, covering data model changes, YAML examples, validation rules, command interface, install flow for both source and image entries, skip logic, and error handling.
List Output Formatting Plan
docs/dev/plans/2026-05-01-list-output-formatting.md
Structured plan to implement digest truncation and timestamp humanization in list output via go-humanize dependency, including tests, implementation helpers, flag wiring, and verification steps.
List Output Formatting Spec
docs/dev/specs/2026-05-01-list-output-formatting-design.md
Design specification for skillctl list output formatting changes: removes digest prefix and truncates to 12 chars by default, humanizes timestamps, with --no-trunc flag for full output.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch refactor/restructure-docs-site

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com>
Signed-off-by: Pavel Anni <panni@redhat.com>
@pavelanni pavelanni marked this pull request as ready for review May 6, 2026 00:20
@pavelanni pavelanni merged commit 92dde21 into main May 6, 2026
6 checks passed
@pavelanni pavelanni deleted the refactor/restructure-docs-site branch May 6, 2026 00:20
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.

Restructure docs/ and site/ directories

1 participant