diff --git a/docs/_config.yml b/docs/_config.yml index 7909db1..7c1b58c 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,8 +1,6 @@ title: "Fix: Happy Path to Ruby Testing" author: name: Cyril Kato - url: "https://github.com/cyril" - description: > Fix is a modern Ruby testing framework built around a key architectural principle: the complete separation between specifications and tests. It allows you to write @@ -13,36 +11,15 @@ remote_theme: jekyll/minima plugins: - jekyll-feed - jekyll-remote-theme - - jekyll-sitemap - - jekyll-seo-tag minima: skin: auto social_links: - - { platform: github, user_url: "https://github.com/fixrb/fix" } - - { platform: x, user_url: "https://x.com/fix_rb" } - - { platform: bsky, user_url: "https://bsky.app/profile/fixrb.dev" } - - { platform: rss, user_url: "/feed.xml" } + - { platform: github, user_url: "https://github.com/fixrb/fix" } + - { platform: x, user_url: "https://x.com/fix_rb" } + - { platform: bsky, user_url: "https://bsky.app/profile/fixrb.dev" } -# Feed configuration feed: icon: /favicon.png logo: /favicon.png posts_limit: 100 - -# SEO -twitter: - username: fix_rb - card: summary - -social: - name: Fix Framework - links: - - https://github.com/fixrb/fix - - https://x.com/fix_rb - - https://bsky.app/profile/fixrb.dev - -# GitHub Pages specific -github: - is_project_page: true - repository_url: "https://github.com/fixrb/fix" diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index 4896887..f81886f 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -2,33 +2,36 @@
+ +
+ diff --git a/docs/about.md b/docs/about.md deleted file mode 100644 index 9bc6c8b..0000000 --- a/docs/about.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: page -title: About -permalink: /about/ ---- - -## About Fix - -Fix is a modern Ruby testing framework conceived with a fundamental architectural principle: strict separation between specifications and their implementation. This unique approach allows developers to write clearer, more maintainable tests while providing solid guarantees about their code's behavior. - -### Philosophy - -Fix was born from a simple observation: testing frameworks shouldn't be more complex than the code they test. Built with minimalism in mind and powered by modular components (Defi, Matchi, Spectus), Fix brings clarity and joy to Ruby testing. - -### Key Components - -- **[Defi](https://github.com/fixrb/defi)**: Method handling abstraction -- **[Matchi](https://github.com/fixrb/matchi)**: Collection of expectation matchers -- **[Spectus](https://github.com/fixrb/spectus)**: Test runner with RFC 2119 semantics - -### Project History - -Originally released in 2015, Fix was created to address the growing complexity in Ruby testing frameworks. The project has evolved while maintaining its core principle: making testing both rigorous and enjoyable. diff --git a/docs/index.md b/docs/index.md index 08f253a..e69de29 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,46 +0,0 @@ ---- -layout: home -title: "Fix: Happy Path to Ruby Testing" ---- - -## Modern Ruby Testing Framework - -Fix is a modern Ruby testing framework that emphasizes clear separation between specifications and examples. Unlike traditional testing frameworks, Fix focuses on creating pure specification documents that define expected behaviors without mixing in implementation details. - -### Getting Started - -Add to your Gemfile: - -```ruby -gem "fix" -``` - -Or install it yourself: - -```sh -gem install fix -``` - -### Key Features - -- **Pure Specifications**: Write specification documents that focus solely on defining behaviors -- **Semantic Precision**: Use MUST, SHOULD, and MAY to clearly define requirement levels -- **Clear Separation**: Keep specifications and implementations separate for better maintainability -- **Fast Execution**: Run tests quickly and independently -- **Rich Matcher Library**: Comprehensive set of matchers for different testing needs - -### Quick Example - -```ruby -# Define your specification -Fix :Calculator do - on(:add, 2, 3) do - it MUST eq 5 - end -end - -# Test your implementation -Fix[:Calculator].test { Calculator } -``` - -Discover more about Fix in our [documentation](https://rubydoc.info/gems/fix) or check our [source code](https://github.com/fixrb/fix).