[codex] Update v3.4 website, samples, daemon hosting, and forms runtime#31
Merged
Conversation
…multi-writer follow-up plan
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR broadens the
v3.4.0website/docs cleanup into a fuller sample andruntime-hosting pass.
On the website side, the repo now preserves the source-heavy markdown guides
under companion source-reference HTML pages and removes only the duplicated
markdown files that were verified as safe to delete. The site work also adds a
new blog post covering the C# launcher pattern for
CSharpDB.Admin.On the sample side, this PR adds
samples/fulfillment-hub, a runnableoperations showcase that seeds relational schema, views, triggers, procedures,
saved queries, Admin forms, Admin reports, stored pipelines, typed collections,
and a full-text index into one sample database. The sample README is now a
guided story walkthrough so users can learn the platform by running through a
day in warehouse operations instead of reading a flat checklist.
This PR also adds
src/CSharpDB.Admin.Forms.Web, a forms-only web host thatlists stored forms from a target database and runs them without exposing design
mode. The new host reuses the existing
DataEntryruntime component fromCSharpDB.Admin.Forms, with small opt-in parameters added so runtime-only hostscan hide the designer action and provide a back link without changing default
Admin studio behavior.
The current range also includes a small Admin UI polish pass: the form designer
property inspector now renders selected control IDs with theme-aware styling,
the SQL query tab has a visible resizable splitter between editor and results,
and the visual query designer has a matching splitter for the generated SQL
preview versus results.
The final website pass also adds the Fulfillment Hub sample walkthrough blog
post, applies consistent tutorial code color-coding across the static docs,
updates the REST API reference to reflect daemon-hosted REST/gRPC, and refreshes
the v3.4 changelog plus roadmap entries.
Type of Change
Related Issues
No issue numbers were linked for this docs/site, sample, and forms-runtime
work. Included work in this PR:
docs/markdown tree against the publishedwwwsiteCSharpDB.AdminC# launcher blog post to the websitesamples/fulfillment-hubrunnable sample with forms, reports,procedures, saved queries, pipelines, collections, and full-text search
CSharpDB.Admin.Forms.Webruntime-only forms hostCSharpDB.Admin.Formsruntime entry so the shared form runner can behosted without a visible designer action
longer relies on hard-to-read readonly input colors in dark theme
Testing
dotnet build CSharpDB.slnxDbExceptionpaths)Validation performed for this PR:
docs/architecture.md->www/architecture-reference.htmldocs/getting-started.md->www/docs/getting-started-reference.htmldocs/performance.md->www/docs/performance-reference.htmldocs/query-execution-pipeline.md->www/docs/query-execution-pipeline.htmldocs/sql-reference.md->www/docs/sql-reference.htmldocs/storage/README.md->www/docs/storage-engine-reference.htmldocs/roadmap.md->www/roadmap-reference.htmldocs/query-and-durable-write-performance/csharpdb-vs-sqlite-benchmarking-blog.md->www/blog/csharpdb-vs-sqlite-benchmarking-reference.htmlthe migrated source-reference set
python -c "import xml.etree.ElementTree as ET; ET.parse('www/sitemap.xml')"passed after updating the sitemap
files (
cli.md,rest-api.md,mcp-server.md,internals.md,storage-inspector.md)dotnet run --project samples\fulfillment-hub\FulfillmentHubSample.csprojcompleted successfully and seeded the sample database with:
3forms3reports5procedures5saved queries3stored pipelines and3successful pipeline runs2collectionsfts_ops_playbooksfull-text indexdotnet build src\CSharpDB.Admin.Forms.Web\CSharpDB.Admin.Forms.Web.csprojcompleted successfully
dotnet build src\CSharpDB.Admin.Forms\CSharpDB.Admin.Forms.csprojcompleted successfully after the property inspector styling change
dotnet build src\CSharpDB.Admin\CSharpDB.Admin.csproj -p:BaseOutputPath=C:\Users\maxim\source\Code\CSharpDB\artifacts\verify\completed successfully after the query tab and visual designer splitter
changes
1644passed,0failed, and0skipped across:
CSharpDB.Admin.Forms.TestsCSharpDB.Admin.Reports.TestsCSharpDB.Api.TestsCSharpDB.Cli.TestsCSharpDB.Daemon.TestsCSharpDB.Data.TestsCSharpDB.EntityFrameworkCore.TestsCSharpDB.Pipelines.TestsCSharpDB.Testsnode --check www\js\csharpdb.bundle.jspassed after adding the static docscode highlighter
and the REST API reference renders with daemon-hosted REST wording
dotnet run --project src\CSharpDB.Admin.Forms.Web\CSharpDB.Admin.Forms.Web.csproj -- --urls http://127.0.0.1:5095 --CSharpDB:DataSource=<fulfillment-hub-demo.db>started successfully
/lists the seeded formsOrder Workbench,Purchase Order Receiving,and
Return Intake/forms/orders-workbenchreturns200SaveandDeleteEdit Formdesigner actionChecklist
Notes for Reviewers
docs/query-execution-pipeline.mdcontent is no longer implicitly treated asif it were the same page as the shipped ETL pipelines guide. It now has its
own source-reference route under
www/docs/query-execution-pipeline.html.source-reference pages exist to preserve the original long-form markdown
material before deleting redundant copies from
docs/.The remaining markdown files still need their own migration/verification work
before they are safe to delete.
DataEntryruntimecomponent rather than forking it into a separate codepath. The only shared
component changes are opt-in runtime-hosting parameters; existing Admin
behavior stays unchanged by default.
the form designer property inspector, one splitter for SQL mode, and one
splitter for visual designer mode.
client-side highlighter in
www/js/csharpdb.bundle.js; it uses the existingsite token classes and does not add a new third-party dependency.