Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
c18de99
squash-commit
mwsis Aug 28, 2026
b08f3e5
chore(doc): update documentation metadata for 0.39.11
mwsis Aug 28, 2026
431b69c
chore(doc): establish component documentation structure
mwsis Aug 28, 2026
7815cae
docs(components): document container selection and behaviour
mwsis Aug 28, 2026
de4d4cd
docs(components): document scalar conversion policies
mwsis Aug 28, 2026
7008f9f
docs(components): document string transformation and matching semantics
mwsis Aug 28, 2026
553ee44
docs(components): document diagnostic context and exception chaining
mwsis Aug 28, 2026
a02fedb
docs(components): document Ruby extension loading and semantics
mwsis Aug 28, 2026
cc0a451
docs(components): document hash transformation and matching semantics
mwsis Aug 28, 2026
387b927
docs(components): document parameter and option validation
mwsis Aug 28, 2026
12dd71b
docs(components): document human-readable array formatting
mwsis Aug 28, 2026
61e7c87
docs(components): document command-line option mapping
mwsis Aug 28, 2026
b4c4468
docs(components): document structured IO writing
mwsis Aug 28, 2026
ba01eae
docs(guides): add the xqsr3 getting-started workflow
mwsis Aug 28, 2026
a356bab
docs(guides): add component selection guidance
mwsis Aug 28, 2026
f280a9d
docs(guides): document external input processing
mwsis Aug 28, 2026
cddffd7
docs(reference): establish the generated API reference
mwsis Aug 28, 2026
77bf014
docs(reference): complete generated API documentation coverage
mwsis Aug 28, 2026
9411181
ci(docs): verify generated API reference coverage
mwsis Aug 28, 2026
4c5ce26
docs(reference): exclude the private BoolParser helper
mwsis Aug 28, 2026
233a2f2
docs(xqsr3): complete task-oriented workflow documentation
mwsis Aug 28, 2026
d26271d
docs(xqsr3): complete curated component catalogue
mwsis Aug 28, 2026
a8a46e0
squash-commit
mwsis Aug 29, 2026
3c0695d
Merge branch 'dev' into 'doc.1'
mwsis Aug 29, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .github/workflows/ruby.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

#
# Created: 29th August 2025
# Updated: 28th August 2026
# Updated: 29th August 2026
#

name: Ruby
Expand All @@ -20,8 +20,6 @@ on:
- boilerplate
- doc
- doc.1
- doc.2
- doc.3
- idiomatic
- rc1
- rc2
Expand Down
2 changes: 1 addition & 1 deletion TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
24 changes: 24 additions & 0 deletions docs/components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ file.

- [Using the catalogue](#using-the-catalogue)
- [Categories](#categories)
- [Related workflows](#related-workflows)


## Using the catalogue
Expand All @@ -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

Expand All @@ -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.


<!-- ########################### end of file ########################### -->