Skip to content

Update dependencies and enhance documentation for OpenAF#1834

Merged
nmaguiar merged 10 commits into
masterfrom
t8
May 16, 2026
Merged

Update dependencies and enhance documentation for OpenAF#1834
nmaguiar merged 10 commits into
masterfrom
t8

Conversation

@nmaguiar
Copy link
Copy Markdown
Collaborator

This pull request enhances documentation and developer usability for OpenAF channels and frontend generation. The main changes are the addition of comprehensive inline documentation for all built-in channel types in owrap.ch.js, new odoc documentation for developer utilities in owrap.dev.js, and the introduction of a detailed "LLM Frontend Guide" for generating offline-first UIs using OpenAF HTTP servers and assets.

Documentation improvements for channel types:

  • Added detailed <odoc> documentation blocks for the following channel types in owrap.ch.js, describing their purpose, options, and usage examples:
    • big: In-memory, compressed, sorted key/value storage optimized for large datasets.
    • cache: Function- or channel-backed caching with TTL, size, and eviction options.
    • dummy: No-op sink for disabling channels.
    • simpleold: Legacy in-memory key/value store for backward compatibility.
    • simple: Default in-memory key/value store, Map-backed, modification-order preserving.
    • remote: Connects to remote channels via HTTP(S) using the OpenAF REST channel protocol.
    • etcd: Connects to an etcd v2 key/value store over HTTP.

Developer utility documentation:

  • Added <odoc> documentation for ow.dev.loadChFn() (registers a function-backed channel type) and ow.dev.loadPoolDB() (registers a pooled database-backed channel type) in owrap.dev.js. [1] [2]

Frontend generation and documentation:

  • Added a new file docs/llm-frontend-guide.md providing a comprehensive guide for generating offline-first, mobile-responsive UIs and oJobs using OpenAF mapped HTTP assets, with code samples, best practices, acceptance criteria, and reference files.
  • Updated docs/index.md to reference the new frontend and LLM integration guides, and replaced an outdated terminal visualization entry with a new testing guidelines entry.

nmaguiar added 9 commits May 9, 2026 18:12
Update the PostgreSQL JDBC driver version from 42.7.10 to 42.7.11 in pom.xml and pom.json, and update the corresponding jar file.
Update lib/javax.mail.jar and add com.sun.mail:jakarta.mail:1.6.8 to pom.xml
- Add <odoc> blocks to big, cache, dummy, simpleold, and simple channel implementations in js/owrap.ch.js
- Remove lib/javax.mail.jar and update pom.json to use the jakarta.mail dependency instead
Adds detailed documentation blocks for several functions in owrap.dev, owrap.oBook, and owrap.python, including loadChFn, loadPoolDB, loadIgnite, doh, JSDebug, and the oBook interaction system.
Update various Jetty components from 12.1.8 to 12.1.9 and add the jakarta.mail-1.6.8.jar library.
Create a comprehensive guide for generating OpenAF frontends that
leverage built-in HTTP assets and offline-first patterns. Update
docs/index.md to include the new guide in the AI & Processing section.
Create a comprehensive guide for generating terminal user interfaces using OpenAF primitives, ensuring offline compatibility, capability awareness, and adherence to TUI best practices.
@nmaguiar nmaguiar self-assigned this May 16, 2026
@nmaguiar nmaguiar added bug enhancement dependencies Pull requests that update a dependency file labels May 16, 2026
@nmaguiar nmaguiar merged commit 0dd9bc4 into master May 16, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug dependencies Pull requests that update a dependency file enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant