Skip to content

docs(readme): add workbench plug above the fold#196

Merged
fede-kamel merged 1 commit into
mainfrom
chore/readme-workbench-plug
May 15, 2026
Merged

docs(readme): add workbench plug above the fold#196
fede-kamel merged 1 commit into
mainfrom
chore/readme-workbench-plug

Conversation

@fede-kamel
Copy link
Copy Markdown
Contributor

Summary

Surface the Workbench prominently at the top of the README. Before this PR, the only mention was a single word in the centered nav row, linking to the in-repo workbench/ source dir. After: a dedicated CTA right below the nav, with a one-line pitch and a direct link to the Workbench guide. Also fixed the existing nav Workbench entry to point at the public docs page instead of workbench/.

Diff

<p align="center">
  <strong>Try every locus pattern in your browser →</strong>
  <a href="https://oracle-samples.github.io/locus/workbench/"><strong>Workbench guide</strong></a><br>
  <em>Step-by-step setup for the browser playground — run it on localhost
  in three terminals, or in a single Docker container. Bring your own
  OpenAI / Anthropic key, or wire up an OCI profile.</em>
</p>

Test plan

  • Markdown renders correctly (markdownlint pre-commit pass).
  • CI green.

The Workbench is the fastest way for a first-time visitor to see what
locus actually does, but the only mention was a single word in the nav
row pointing at the repo source directory. Surface it as its own CTA
right below the nav so it's hard to miss, and switch the nav entry to
the public docs page instead of the in-repo workbench/ directory.

Signed-off-by: Federico Kamelhar <federico.kamelhar@oracle.com>
@oracle-contributor-agreement oracle-contributor-agreement Bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label May 15, 2026
@fede-kamel fede-kamel merged commit 3da0944 into main May 15, 2026
10 checks passed
@fede-kamel fede-kamel deleted the chore/readme-workbench-plug branch May 15, 2026 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

OCA Verified All contributors have signed the Oracle Contributor Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant