diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml index 7ef66b7..a009ab3 100644 --- a/.github/workflows/ruby.yml +++ b/.github/workflows/ruby.yml @@ -7,7 +7,7 @@ # # Created: 29th August 2025 -# Updated: 28th August 2026 +# Updated: 29th August 2026 # name: Ruby @@ -20,8 +20,6 @@ on: - boilerplate - doc - doc.1 - - doc.2 - - doc.3 - idiomatic - rc1 - rc2 diff --git a/TODO.md b/TODO.md index 8551a09..8035306 100644 --- a/TODO.md +++ b/TODO.md @@ -9,7 +9,7 @@ ## Documentation -* [ ] Curated component catalogue under **docs/components/**; +* [x] ~~~curated component catalogue under **docs/components/**~~~; * [x] ~~~task-oriented user guide under **docs/guides/**~~~; * [ ] Expanded generated API reference; * [ ] Executable cookbook and recipe documentation; diff --git a/docs/components/README.md b/docs/components/README.md index a5a2039..a88e9dd 100644 --- a/docs/components/README.md +++ b/docs/components/README.md @@ -9,6 +9,7 @@ file. - [Using the catalogue](#using-the-catalogue) - [Categories](#categories) +- [Related workflows](#related-workflows) ## Using the catalogue @@ -19,6 +20,11 @@ Components are loaded explicitly. Each category page documents the relevant The catalogue documents the supported public surface. Internal files and implementation details are intentionally excluded. +The ten category pages correspond to the public top-level component entry +points under `lib/xqsr3/`. The `Extensions` page additionally covers the +opt-in monkey patches, while `all_extensions.rb` is documented as its +broad-scope loading choice. + ## Categories @@ -34,4 +40,22 @@ implementation details are intentionally excluded. * [String Utilities](./string-utilities.md); +## Related workflows + +Use the catalogue alongside the task-oriented guides: + +* [Choosing a Component](../guides/choosing-a-component.md) explains how to + select a category and loading scope; +* [Getting Started](../guides/getting-started.md) demonstrates a minimal + application workflow; +* [Parsing and Validating External Input](../guides/parsing-and-validating-input.md) + combines string, conversion, and quality components; +* [Processing Collections](../guides/processing-collections.md) combines + containers, hash utilities, and extensions; +* [Handling Failures](../guides/handling-failures.md) combines quality and + diagnostics components; +* [Formatting and Writing Output](../guides/formatting-and-writing-output.md) + combines array, IO, and string utilities. + +