Skip to content

docs: add SQL activities guide - #273

Open
sfmskywalker wants to merge 1 commit into
mainfrom
codex/daily-doc-087-sql
Open

docs: add SQL activities guide#273
sfmskywalker wants to merge 1 commit into
mainfrom
codex/daily-doc-087-sql

Conversation

@sfmskywalker

Copy link
Copy Markdown
Member

Summary

  • add a release-backed SQL activities guide for server-side setup and Studio users
  • document provider registration, query/command/scalar contracts, SQL placeholders, custom clients, and result/serialization limits
  • link the guide from the activity reference, extensibility guide, and navigation
  • update documentation coverage and slice metadata for DOC-087

Validation

  • release-source contract assertions against Core 01db86e, Studio 2b131f9, and Extensions a44e2b0 on release/3.8.0
  • local-link, SUMMARY.md, fenced-code, whitespace, and git diff --check validation
  • HTTP 200 checks for cited release-source links
  • no local Markdownlint, Vale, Lychee, or GitBook command is available

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new, release-backed guide documenting Elsa 3.8.0 SQL activities and wires it into the GitBook navigation and cross-reference pages, while updating internal documentation-slice tracking metadata.

Changes:

  • Add a new activities/sql.md guide covering server-side setup, provider/client registration, activity contracts, placeholder binding, and result/serialization limitations.
  • Link the new SQL guide from the activity reference, extensibility guide, and GitBook navigation (SUMMARY.md).
  • Update documentation coverage and backlog slice metadata to reflect completion of DOC-087.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
SUMMARY.md Adds the SQL activities page to the main navigation.
guides/extensibility/modules-and-plugins.md Links the SQL activities guide from the extensibility/module guide.
docs/meta/current-coverage.md Updates coverage inventory to include SQL activities (and adjusts counts).
docs/meta/backlog.md Updates slice inventory metadata and records completion details for DOC-087.
activities/sql.md New SQL activities guide with setup, usage, and limitations for 3.8.0.
activities/activity-reference.md Adds the SQL guide to the activity reference list.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread activities/sql.md
SQL inputs use the `Sql` expression type. A placeholder is written with
double braces and can reference these 3.8.0 roots:

```liquid
Comment thread activities/sql.md
Comment on lines +220 to +224
public sealed class AcmeSqlClient(string connectionString)
: BaseSqlClient(connectionString)
{
protected override DbConnection CreateConnection() =>
new AcmeConnection(_connectionString);
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

codex codex-automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants