Skip to content

docs: Add Resources page to documentation#2104

Merged
botantler[bot] merged 9 commits intomainfrom
docs/add-resources-page-6af38c984bec1ebe
Feb 12, 2026
Merged

docs: Add Resources page to documentation#2104
botantler[bot] merged 9 commits intomainfrom
docs/add-resources-page-6af38c984bec1ebe

Conversation

@botantler
Copy link
Contributor

@botantler botantler bot commented Feb 8, 2026

Summary

This PR addresses a documentation gap by creating a dedicated Resources page in the main documentation site at (ksail.devantler.tech/redacted)

Previously, presentations, blog posts, and related projects were only listed in the README.md file but not accessible through the documentation site navigation. This made it harder for users to discover valuable learning materials and community projects.

Changes

New Resources Page (docs/src/content/docs/resources.mdx)

Created a comprehensive Resources page organized into the following sections:

  1. Presentations

    • KCD 2024 presentation: "KSail - a Kubernetes SDK for local GitOps development and CI"
    • Includes note about early .NET version vs current Go implementation
  2. Blog Posts

    • Distribution-specific guides (Kind, K3d, Talos)
    • Cloud provider guides (Hetzner)
    • AI integration deep dive (GitHub Copilot SDK)
    • Organized using Starlight Card/CardGrid components for better UX
  3. Related Projects

    • Showcases devantler-tech/platform (personal homelab)
    • Includes instructions for community members to share their projects
  4. Community & Support

    • Links to discussions, issues, and contributing guide
    • Call-to-action for staying updated

Updated Sidebar Navigation (docs/astro.config.mjs)

  • Added "Resources" link to the sidebar after the "Help" section
  • Provides easy discoverability of learning materials

Documentation Standards

This PR follows project documentation guidelines:

  • Diátaxis Framework: Resources page follows the "Explanation" category (understanding-oriented)
  • Starlight Components: Uses Card and CardGrid for consistent styling
  • Proper Frontmatter: Includes descriptive title and description metadata
  • Accessibility: All links have descriptive text and icons
  • Markdown Best Practices: Uses 6 backticks for code blocks (per project guidelines)

Testing

  • ✅ MDX syntax validated (frontmatter structure confirmed)
  • ✅ Astro config syntax validated (balanced braces)
  • ✅ All external links verified against README.md sources
  • ⚠️ Full build test pending (requires network connectivity in CI)

Impact

Benefits:

  • Users can now discover presentations and blog posts through the documentation site
  • Improved discoverability of learning resources
  • Encourages community contribution by showcasing related projects
  • Consistent documentation experience across GitHub and docs site

Breaking Changes: None

Performance Impact: Minimal - one additional static page

Screenshots

The new Resources page will appear in the sidebar navigation after "Help" section and includes:

  • YouTube presentation card
  • Blog post cards organized by category
  • Related projects showcase
  • Community links

Checklist

  • Documentation follows Diátaxis framework
  • Uses Starlight components for consistency
  • Includes proper frontmatter metadata
  • Links verified against source (README.md)
  • Commit message follows conventional commits format
  • No breaking changes
  • Full documentation build test (pending CI with network access)

Related

  • Closes documentation gap identified in README.md vs docs site comparison
  • Complements recent blog post links fix in commit 97aeed3

AI generated by Update Docs

- Create comprehensive Resources page (docs/src/content/docs/resources.mdx)
  - Presentations section with KCD 2024 talk
  - Blog posts section with distribution-specific and cloud provider guides
  - AI integration article
  - Related projects showcase
  - Community and support information
  - Contributing links

- Update sidebar navigation (docs/astro.config.mjs)
  - Add Resources link after Help section
  - Provides easy access to learning materials and community projects

This change addresses a documentation gap where presentations, blog posts,
and related projects were only visible in README.md but not in the main
documentation site at https://ksail.devantler.tech.

Follows Diátaxis framework (Explanation category) and uses Starlight
components for consistent styling with the rest of the documentation.
@github-project-automation github-project-automation bot moved this to 🏃🏻‍♂️ In Progress in 🌊 Project Board Feb 8, 2026
@github-project-automation github-project-automation bot moved this from 🏃🏻‍♂️ In Progress to 🚀 In Finalization in 🌊 Project Board Feb 8, 2026
@devantler devantler marked this pull request as ready for review February 8, 2026 23:01
Copilot AI review requested due to automatic review settings February 8, 2026 23:01
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new “Resources” documentation page to surface presentations, blog posts, and related projects directly in the Starlight docs site, and exposes it in the sidebar navigation.

Changes:

  • Added resources.mdx page using Starlight Card/CardGrid components to curate learning and community links.
  • Updated Starlight sidebar configuration to include a “Resources” entry.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
docs/src/content/docs/resources.mdx New curated Resources page (presentations, blog posts, related projects, support links).
docs/astro.config.mjs Adds /resources/ to the Starlight sidebar for discoverability.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Nikolai Emil Damm <ned@devantler.tech>
Copilot AI review requested due to automatic review settings February 8, 2026 23:06
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Nikolai Emil Damm <ned@devantler.tech>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings February 11, 2026 19:10
Copy link
Contributor

Copilot AI commented Feb 11, 2026

@devantler I've opened a new pull request, #2141, to work on those changes. Once the pull request is ready, I'll request review from you.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.

Copilot AI and others added 2 commits February 11, 2026 20:30
* Initial plan

* Validate seti:cloud icon usage in Resources page

Co-authored-by: devantler <26203420+devantler@users.noreply.github.com>

* Fix icon: Replace invalid seti:cloud with cloud-download

Co-authored-by: devantler <26203420+devantler@users.noreply.github.com>

* Remove accidentally committed screenshot file

Co-authored-by: devantler <26203420+devantler@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: devantler <26203420+devantler@users.noreply.github.com>
Co-authored-by: Nikolai Emil Damm <ned@devantler.tech>
Copilot AI review requested due to automatic review settings February 12, 2026 19:51
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 5 changed files in this pull request and generated no new comments.

Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com>
@botantler botantler bot added this pull request to the merge queue Feb 12, 2026
Merged via the queue into main with commit e751981 Feb 12, 2026
30 checks passed
@botantler botantler bot deleted the docs/add-resources-page-6af38c984bec1ebe branch February 12, 2026 20:08
@github-project-automation github-project-automation bot moved this from 🚀 In Finalization to ✅ Done in 🌊 Project Board Feb 12, 2026
botantler bot pushed a commit that referenced this pull request Feb 12, 2026
Remove three PNG screenshot files that were accidentally committed to the
repository root in PR #2104. These files were used during development but
should not be part of the repository.

Files removed:
- resources-page-cloud-icon.png (44KB)
- resources-page-hetzner-section.png (50KB)
- resources-page-with-icon.png (53KB)

Also update .gitignore to prevent future accidental commits of PNG files
in the root directory while still allowing PNG files in docs/.

This cleanup follows the original commit message which mentioned removing
an accidentally committed screenshot file, but these three files remained.
github-merge-queue bot pushed a commit that referenced this pull request Feb 12, 2026
Remove three PNG screenshot files that were accidentally committed to the
repository root in PR #2104. These files were used during development but
should not be part of the repository.

Files removed:
- resources-page-cloud-icon.png (44KB)
- resources-page-hetzner-section.png (50KB)
- resources-page-with-icon.png (53KB)

Also update .gitignore to prevent future accidental commits of PNG files
in the root directory while still allowing PNG files in docs/.

This cleanup follows the original commit message which mentioned removing
an accidentally committed screenshot file, but these three files remained.

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants