fractor 0.1.6 → 0.1.7

data/docs/.lycheeignore

@@ -0,0 +1,16 @@
+# Ignore localhost links (used in examples)
+http://localhost
+https://localhost
+
+# Ignore relative links (checked by Jekyll)
+file://
+
+# Ignore example domains
+https://api.example.com
+http://example.com
+https://example.com
+
+# Ignore GitHub commit/issue placeholders
+https://github.com/*/*/issues/#
+https://github.com/*/*/pull/#
+https://github.com/*/*/commit/#

data/docs/Gemfile

@@ -0,0 +1,24 @@
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.3"
+gem "just-the-docs", "~> 0.7"
+
+group :jekyll_plugins do
+  gem "jekyll-asciidoc"
+  gem "jekyll-seo-tag"
+  gem "jekyll-sitemap"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", ">= 1", "< 3"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1", platforms: %i[mingw x64_mingw mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", platforms: [:jruby]

data/docs/README.md

@@ -0,0 +1,157 @@
+# Fractor Documentation
+
+This directory contains the documentation for Fractor, built with Jekyll and the just-the-docs theme.
+
+## Building Locally
+
+### Prerequisites
+
+- Ruby 3.0 or later
+- Bundler (`gem install bundler`)
+
+### Setup
+
+Install dependencies:
+
+```bash
+cd docs
+bundle install
+```
+
+### Development Server
+
+Run the Jekyll development server:
+
+```bash
+cd docs
+bundle install
+bundle exec jekyll serve --livereload --baseurl /fractor
+```
+
+Then visit http://localhost:4000/fractor in your browser.
+
+The `--livereload` option enables automatic page refresh when files change.
+The `--baseurl /fractor` option matches the GitHub Pages deployment URL.
+
+### Building for Production
+
+Build the static site:
+
+```bash
+bundle exec jekyll build
+```
+
+The generated site will be in `_site/`.
+
+## Link Checking
+
+This documentation uses [lychee](https://github.com/lycheeverse/lychee) for link validation.
+
+### Install lychee
+
+```bash
+# macOS
+brew install lychee
+
+# Cargo (all platforms)
+cargo install lychee
+
+# Or download binary from releases
+```
+
+### Run link checker
+
+Check all links in the documentation:
+
+```bash
+lychee docs/
+```
+
+Or check the built site:
+
+```bash
+lychee _site/
+```
+
+Configuration is in `lychee.toml` and `.lycheeignore`.
+
+## Documentation Structure
+
+The documentation follows an onion structure from beginner to advanced:
+
+```
+docs/
+├── index.md                    # Landing page
+├── _tutorials/                 # Beginner guides
+│   ├── index.md
+│   ├── installation.adoc
+│   ├── first-application.adoc
+│   └── getting-started.adoc
+├── _guides/                    # Intermediate topics
+│   ├── index.md
+│   ├── core-concepts.adoc
+│   ├── pipeline-mode.adoc
+│   ├── continuous-mode.adoc
+│   ├── workflows.adoc
+│   ├── error-reporting.adoc
+│   └── signal-handling.adoc
+└── _reference/                 # Advanced/API reference
+    ├── index.md
+    ├── api.adoc
+    ├── examples.adoc
+    └── patterns.adoc
+```
+
+## Writing Documentation
+
+### Front Matter
+
+All documentation files must include YAML front matter:
+
+```yaml
+---
+layout: default
+title: Page Title
+parent: Parent Section
+nav_order: 1
+---
+```
+
+### AsciiDoc Files
+
+AsciiDoc files should:
+- Start with level 2 headings (`==`) not level 1 (`=`)
+- Use proper heading hierarchy
+- Include code syntax highlighting with `[source,language]`
+
+### Markdown Files
+
+Markdown files should:
+- Use `#` for headings (Jekyll will handle levels)
+- Use fenced code blocks with language tags
+- Follow just-the-docs conventions
+
+### Navigation
+
+Navigation is automatically generated from:
+- Front matter `nav_order` values
+- Collection configuration in `_config.yml`
+- Directory structure
+
+## Contributing
+
+When adding new documentation:
+
+1. Choose the appropriate section (tutorials/guides/reference)
+2. Add proper front matter
+3. Use consistent heading levels
+4. Add code examples where relevant
+5. Test locally with `bundle exec jekyll serve`
+6. Run link checker: `lychee docs/`
+7. Submit a pull request
+
+## Deployment
+
+Documentation is automatically deployed to GitHub Pages when changes are merged to the main branch.
+
+Site URL: https://metanorma.github.io/fractor

data/docs/_config.yml

@@ -0,0 +1,151 @@
+# Site settings
+title: Fractor
+description: >-
+  Parallel processing framework for Ruby using Ractors
+baseurl: "/fractor"
+url: "https://metanorma.github.io"
+
+# Theme
+theme: just-the-docs
+remote_theme: just-the-docs/just-the-docs@v0.7.0
+
+# Logo
+logo: "/assets/images/fractor-logo.svg"
+favicon_ico: "/assets/images/favicon.ico"
+
+# Color scheme
+color_scheme: light
+
+# Search
+search_enabled: true
+search:
+  heading_level: 2
+  previews: 3
+  preview_words_before: 5
+  preview_words_after: 10
+  tokenizer_separator: /[\s/]+/
+  rel_url: true
+  button: false
+
+# Heading anchors
+heading_anchors: true
+
+# Aux links for the upper right navigation
+aux_links:
+  "GitHub":
+    - "https://github.com/metanorma/fractor"
+  "RubyGems":
+    - "https://rubygems.org/gems/fractor"
+
+# Makes Aux links open in a new tab
+aux_links_new_tab: true
+
+# Back to top link
+back_to_top: true
+back_to_top_text: "Back to top"
+
+# Footer content
+footer_content: >-
+  Copyright © 2025 Ribose. Distributed by an
+  <a href="https://github.com/metanorma/fractor/blob/main/LICENSE">MIT license</a>.
+
+# Footer last edit timestamp
+last_edit_timestamp: true
+last_edit_time_format: "%b %e %Y at %I:%M %p"
+
+# Navigation structure
+nav_sort: order
+
+# Collections for organizing content
+collections:
+  pages:
+    permalink: "/:path/"
+    output: true
+  tutorials:
+    permalink: "/:collection/:path/"
+    output: true
+  guides:
+    permalink: "/:collection/:path/"
+    output: true
+  features:
+    permalink: "/:collection/:path/"
+    output: true
+  reference:
+    permalink: "/:collection/:path/"
+    output: true
+
+# Just the Docs collection configuration
+just_the_docs:
+  collections:
+    pages:
+      name: Core topics
+      nav_fold: false
+    tutorials:
+      name: Tutorials
+      nav_fold: true
+    guides:
+      name: Guides
+      nav_fold: true
+    features:
+      name: Features
+      nav_fold: true
+    reference:
+      name: Reference
+      nav_fold: true
+
+# Plugins
+plugins:
+  - jekyll-asciidoc
+  - jekyll-seo-tag
+  - jekyll-sitemap
+
+# AsciiDoc configuration
+asciidoc: {}
+asciidoctor:
+  attributes:
+    - source-highlighter=rouge
+    - rouge-style=github
+    - icons=font
+    - sectanchors=true
+    - idprefix=
+    - idseparator=-
+    - experimental=true
+
+include:
+  - '*.adoc'
+
+# Exclude from processing
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - node_modules
+  - vendor/bundle/
+  - vendor/cache/
+  - vendor/gems/
+  - vendor/ruby/
+  - "*.gem"
+  - "*.gemspec"
+  - tools/
+  - README.md
+  - Rakefile
+
+# Enable code copy button
+enable_copy_code_button: true
+
+# Callouts
+callouts_level: quiet
+callouts:
+  highlight:
+    color: yellow
+  important:
+    title: Important
+    color: blue
+  new:
+    title: New
+    color: green
+  note:
+    title: Note
+    color: purple
+  warning:
+    title: Warning
+    color: red