assistant 1.0.0.rc1 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/docs.yml +9 -19
- data/.gitignore +0 -3
- data/CHANGELOG.md +8 -31
- data/Gemfile +6 -9
- data/Gemfile.lock +3 -104
- data/README.md +8 -6
- data/Rakefile +17 -11
- data/Steepfile +18 -3
- data/assistant.gemspec +1 -1
- data/docs/.nojekyll +0 -0
- data/docs/404.html +292 -0
- data/docs/_media/apple-touch-icon.png +0 -0
- data/docs/_media/favicon.png +0 -0
- data/docs/_media/home-logo.svg +8 -0
- data/docs/_media/repo-card.png +0 -0
- data/docs/_sidebar.md +29 -0
- data/docs/api-reference.md +22 -11
- data/docs/changelog.md +0 -5
- data/docs/deprecations.md +4 -9
- data/docs/examples/{index.md → README.md} +7 -17
- data/docs/examples/cli-handler.md +39 -13
- data/docs/examples/composing-services.md +45 -13
- data/docs/examples/execute-callbacks.md +49 -13
- data/docs/examples/instrumentation-notifier.md +48 -13
- data/docs/examples/rails-service.md +40 -13
- data/docs/examples/rbs-generator.md +90 -13
- data/docs/examples/sidekiq-worker.md +33 -13
- data/docs/getting-started.md +11 -5
- data/docs/guides/{index.md → README.md} +1 -8
- data/docs/guides/composing-services.md +6 -12
- data/docs/guides/inputs.md +6 -12
- data/docs/guides/logging-and-results.md +9 -15
- data/docs/guides/rbs-and-types.md +151 -13
- data/docs/guides/validation.md +29 -11
- data/docs/index.html +291 -0
- data/docs/index.md +67 -24
- data/docs/roadmap.md +8 -13
- data/lib/assistant/version.rb +1 -1
- metadata +12 -5
- data/_config.yml +0 -87
data/docs/roadmap.md
CHANGED
|
@@ -1,8 +1,3 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Roadmap
|
|
3
|
-
nav_order: 6
|
|
4
|
-
---
|
|
5
|
-
|
|
6
1
|
# Roadmap
|
|
7
2
|
|
|
8
3
|
The full 1.0 plan lives in
|
|
@@ -15,8 +10,8 @@ index ties them together.
|
|
|
15
10
|
| [`README.md`](https://github.com/ramongr/assistant/blob/main/docs/v1/README.md) | Plan index and reading order. |
|
|
16
11
|
| [`00-overview.md`](https://github.com/ramongr/assistant/blob/main/docs/v1/00-overview.md) | 1.0 goals, non-goals, acceptance criteria. |
|
|
17
12
|
| [`01-api-surface.md`](https://github.com/ramongr/assistant/blob/main/docs/v1/01-api-surface.md) | Frozen vs Experimental symbols, stability labels. |
|
|
18
|
-
| [`02-features.md`](https://github.com/ramongr/assistant/blob/main/docs/v1/02-features.md) |
|
|
19
|
-
| [`03-documentation.md`](https://github.com/ramongr/assistant/blob/main/docs/v1/03-documentation.md) |
|
|
13
|
+
| [`02-features.md`](https://github.com/ramongr/assistant/blob/main/docs/v1/02-features.md) | Feature milestones and the promoted "Should" set. |
|
|
14
|
+
| [`03-documentation.md`](https://github.com/ramongr/assistant/blob/main/docs/v1/03-documentation.md) | Documentation deliverables. |
|
|
20
15
|
| [`04-release-checklist.md`](https://github.com/ramongr/assistant/blob/main/docs/v1/04-release-checklist.md) | Pre-release, RC, release, and post-release steps. |
|
|
21
16
|
| [`05-quality-and-tooling.md`](https://github.com/ramongr/assistant/blob/main/docs/v1/05-quality-and-tooling.md) | SimpleCov, RuboCop, Steep, CI matrix. |
|
|
22
17
|
| [`06-migration-0x-to-1.md`](https://github.com/ramongr/assistant/blob/main/docs/v1/06-migration-0x-to-1.md) | The three mechanical rewrites required to upgrade. |
|
|
@@ -25,9 +20,9 @@ index ties them together.
|
|
|
25
20
|
|
|
26
21
|
## Current snapshot
|
|
27
22
|
|
|
28
|
-
- 1.0 release plumbing is
|
|
29
|
-
[`1.0.0
|
|
30
|
-
- Every "Must" milestone
|
|
31
|
-
|
|
32
|
-
- The
|
|
33
|
-
|
|
23
|
+
- 1.0 release plumbing is ready — the gem is prepared for
|
|
24
|
+
[`1.0.0`](changelog.md) and the migration recipe is finalised.
|
|
25
|
+
- Every "Must" milestone and every promoted "Should" item has shipped
|
|
26
|
+
to `main`.
|
|
27
|
+
- The Docsify site you're reading now is live; guide and example content for
|
|
28
|
+
1.0 is in place.
|
data/lib/assistant/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: assistant
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.0
|
|
4
|
+
version: 1.0.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ramon Rodrigues
|
|
@@ -236,29 +236,36 @@ files:
|
|
|
236
236
|
- Rakefile
|
|
237
237
|
- SECURITY.md
|
|
238
238
|
- Steepfile
|
|
239
|
-
- _config.yml
|
|
240
239
|
- assistant.gemspec
|
|
241
240
|
- bin/console
|
|
242
241
|
- bin/setup
|
|
243
242
|
- bin/version
|
|
243
|
+
- docs/.nojekyll
|
|
244
|
+
- docs/404.html
|
|
245
|
+
- docs/_media/apple-touch-icon.png
|
|
246
|
+
- docs/_media/favicon.png
|
|
247
|
+
- docs/_media/home-logo.svg
|
|
248
|
+
- docs/_media/repo-card.png
|
|
249
|
+
- docs/_sidebar.md
|
|
244
250
|
- docs/api-reference.md
|
|
245
251
|
- docs/changelog.md
|
|
246
252
|
- docs/deprecations.md
|
|
253
|
+
- docs/examples/README.md
|
|
247
254
|
- docs/examples/cli-handler.md
|
|
248
255
|
- docs/examples/composing-services.md
|
|
249
256
|
- docs/examples/execute-callbacks.md
|
|
250
|
-
- docs/examples/index.md
|
|
251
257
|
- docs/examples/instrumentation-notifier.md
|
|
252
258
|
- docs/examples/rails-service.md
|
|
253
259
|
- docs/examples/rbs-generator.md
|
|
254
260
|
- docs/examples/sidekiq-worker.md
|
|
255
261
|
- docs/getting-started.md
|
|
262
|
+
- docs/guides/README.md
|
|
256
263
|
- docs/guides/composing-services.md
|
|
257
|
-
- docs/guides/index.md
|
|
258
264
|
- docs/guides/inputs.md
|
|
259
265
|
- docs/guides/logging-and-results.md
|
|
260
266
|
- docs/guides/rbs-and-types.md
|
|
261
267
|
- docs/guides/validation.md
|
|
268
|
+
- docs/index.html
|
|
262
269
|
- docs/index.md
|
|
263
270
|
- docs/roadmap.md
|
|
264
271
|
- exe/assistant-rbs
|
|
@@ -309,7 +316,7 @@ metadata:
|
|
|
309
316
|
allowed_push_host: https://rubygems.org
|
|
310
317
|
bug_tracker_uri: https://github.com/ramongr/assistant/issues
|
|
311
318
|
changelog_uri: https://github.com/ramongr/assistant/blob/main/CHANGELOG.md
|
|
312
|
-
documentation_uri: https://
|
|
319
|
+
documentation_uri: https://ramongr.github.io/assistant/
|
|
313
320
|
homepage_uri: https://github.com/ramongr/assistant
|
|
314
321
|
rubygems_mfa_required: 'true'
|
|
315
322
|
source_code_uri: https://github.com/ramongr/assistant
|
data/_config.yml
DELETED
|
@@ -1,87 +0,0 @@
|
|
|
1
|
-
# Site configuration for the Assistant docs site, deployed to
|
|
2
|
-
# https://ramongr.github.io/assistant/ via .github/workflows/docs.yml.
|
|
3
|
-
# Toolchain: Jekyll 4 + just-the-docs (Ruby). Source files live under
|
|
4
|
-
# docs/. The v1 planning corpus under docs/v1/ is excluded — those are
|
|
5
|
-
# authored-for-GitHub-render plan docs, not site pages.
|
|
6
|
-
|
|
7
|
-
title: Assistant
|
|
8
|
-
description: >-
|
|
9
|
-
Tiny, dependency-free soft-fail service objects for Ruby. Uniform result
|
|
10
|
-
hash, RBS signatures, 1.0-frozen public API, zero runtime gem dependencies.
|
|
11
|
-
url: https://ramongr.github.io
|
|
12
|
-
baseurl: /assistant
|
|
13
|
-
repository: ramongr/assistant
|
|
14
|
-
|
|
15
|
-
# Source layout
|
|
16
|
-
source: docs
|
|
17
|
-
destination: _site
|
|
18
|
-
|
|
19
|
-
# Theme
|
|
20
|
-
theme: just-the-docs
|
|
21
|
-
color_scheme: light
|
|
22
|
-
|
|
23
|
-
# Search
|
|
24
|
-
search_enabled: true
|
|
25
|
-
search:
|
|
26
|
-
heading_level: 3
|
|
27
|
-
previews: 3
|
|
28
|
-
preview_words_before: 5
|
|
29
|
-
preview_words_after: 10
|
|
30
|
-
tokenizer_separator: /[\s/]+/
|
|
31
|
-
rel_url: true
|
|
32
|
-
button: true
|
|
33
|
-
focus_shortcut_key: 'k'
|
|
34
|
-
|
|
35
|
-
# Navigation
|
|
36
|
-
nav_enabled: true
|
|
37
|
-
heading_anchors: true
|
|
38
|
-
|
|
39
|
-
# Aux links (top-right)
|
|
40
|
-
aux_links:
|
|
41
|
-
View on GitHub:
|
|
42
|
-
- https://github.com/ramongr/assistant
|
|
43
|
-
RubyGems:
|
|
44
|
-
- https://rubygems.org/gems/assistant
|
|
45
|
-
aux_links_new_tab: true
|
|
46
|
-
|
|
47
|
-
# Footer
|
|
48
|
-
gh_edit_link: true
|
|
49
|
-
gh_edit_link_text: Edit this page on GitHub
|
|
50
|
-
gh_edit_repository: https://github.com/ramongr/assistant
|
|
51
|
-
gh_edit_branch: main
|
|
52
|
-
gh_edit_source: docs
|
|
53
|
-
gh_edit_view_mode: tree
|
|
54
|
-
|
|
55
|
-
back_to_top: true
|
|
56
|
-
back_to_top_text: Back to top
|
|
57
|
-
|
|
58
|
-
# Build settings
|
|
59
|
-
markdown: kramdown
|
|
60
|
-
kramdown:
|
|
61
|
-
syntax_highlighter: rouge
|
|
62
|
-
input: GFM
|
|
63
|
-
hard_wrap: false
|
|
64
|
-
|
|
65
|
-
# Files Jekyll should ignore. Paths are relative to `source:` (docs/),
|
|
66
|
-
# so `v1` skips docs/v1/ — the v1 planning corpus authored for GitHub's
|
|
67
|
-
# Markdown renderer (relative links into ../ and across plan files). It
|
|
68
|
-
# is intentionally NOT a site route.
|
|
69
|
-
exclude:
|
|
70
|
-
- v1
|
|
71
|
-
- README.md
|
|
72
|
-
|
|
73
|
-
# Jekyll plugins (the GitHub Pages workflow installs these via Bundler;
|
|
74
|
-
# we are not using github-pages gem, so plugins must be safe-listed too)
|
|
75
|
-
plugins:
|
|
76
|
-
- jekyll-seo-tag
|
|
77
|
-
- jekyll-relative-links
|
|
78
|
-
|
|
79
|
-
# Rewrite intra-docs Markdown links (foo.md) to Jekyll URLs so the
|
|
80
|
-
# same files render both on GitHub (where authors keep .md links for
|
|
81
|
-
# context) and on the site (where .html is needed).
|
|
82
|
-
relative_links:
|
|
83
|
-
enabled: true
|
|
84
|
-
collections: false
|
|
85
|
-
|
|
86
|
-
# just-the-docs strict mode is off because the v1 plan docs use
|
|
87
|
-
# kramdown-incompatible link anchors; this site doesn't include them.
|