Skip to content

feat: add doc keel core#1

Merged
juancadev-io merged 17 commits intomainfrom
feat/add-doc-keel-core
Feb 27, 2026
Merged

feat: add doc keel core#1
juancadev-io merged 17 commits intomainfrom
feat/add-doc-keel-core

Conversation

@juancadev-io
Copy link
Contributor

This pull request establishes foundational documentation, configuration, and community standards for the ss-keel-docs repository. It introduces the initial structure for the documentation site, sets up CI workflows, and provides detailed guides for contributing and using the Keel framework and its addons.

The most important changes are:

Documentation Structure and Content:

  • Added a comprehensive README.md describing the Keel framework, documentation structure, contribution guidelines, and community resources.
  • Added initial documentation pages for addons, including overviews and detailed usage guides for upcoming packages such as ss-keel-amqp and ss-keel-cron. [1] [2] [3]
  • Created a custom 404 page in src/content/docs/404.md.

Site and Sidebar Configuration:

  • Updated astro.config.mjs to set the site URL, customize the sidebar navigation with sections for guides, CLI, addons, reference, and community, and update social links and project title.

Community and Contribution Guidelines:

  • Added a repository-specific CONTRIBUTING.md with setup instructions, file organization, and rules for documentation contributions, referencing shared community standards.
  • Added an MIT license file for open-source compliance.

Continuous Integration and Site Metadata:

  • Added CI workflows for validating PRs and running Go-related checks, both in .github/workflows/ci.yml and ci.yml. [1] [2]
  • Added a robots.txt file to allow search engine indexing and provide the sitemap URL.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 27, 2026

Deploying ss-keel-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: b768355
Status: ✅  Deploy successful!
Preview URL: https://84e29766.ss-keel-docs.pages.dev
Branch Preview URL: https://feat-add-doc-keel-core.ss-keel-docs.pages.dev

View logs

@juancadev-io juancadev-io merged commit d39ead3 into main Feb 27, 2026
2 checks passed
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