Skip to content

docs: link glossary from README again - #524

Merged
mrwogu merged 1 commit into
mainfrom
docs/readme-glossary-link
Oct 1, 2026
Merged

mrwogu merged 1 commit into
mainfrom
docs/readme-glossary-link

Conversation

@mrwogu

@mrwogu mrwogu commented Oct 1, 2026 •

Copy link
Copy Markdown
Owner

Description

In #522 I removed the Glossary link from root README because /glossary/ was 404, docs deploy only on release tag. Docs are deployed from main now and https://getpromptscript.dev/glossary/ returns 200, so the link goes back. CLI README already has it.

Related Issue

No issue, follow up after #522.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist

  • My code follows the project's coding standards
  • I have added tests that prove my fix/feature works
  • All new and existing tests pass
  • I have updated the documentation accordingly

Screenshots (if applicable)

Additional Notes

One line in the docs table, nothing else.

Summary by CodeRabbit

  • Documentation
    • Added a Glossary link covering PromptScript terms.

@coderabbitai

coderabbitai Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

🧰 Additional context used
📚 Code guidelines (1)
.github/copilot-instructions.md — auto-discovered

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: mrwogu/promptscript/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: e512cbb4-da04-4990-8c3d-cfe9d4b194af

📥 Commits

Reviewing files that changed from the base of the PR and between a426289 and 6aa6541.

📒 Files selected for processing (1)
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README Documentation table now includes a link to the PromptScript glossary and a description of its contents.

Changes

Documentation

Layer / File(s) Summary
Glossary link
README.md
The Documentation table links to the PromptScript glossary and describes it as covering PromptScript terms.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 6aa65

The glossary link is labeled clearly and leads to the intended page. No actionable merge risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to 6aa65

The change affects 1 system.

Changed systems: README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.md: The Documentation table gains a Glossary link and description.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: restoring the Glossary link in the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sonarqubecloud

sonarqubecloud Bot commented Oct 1, 2026

Copy link
Copy Markdown

@codecov

codecov Bot commented Oct 1, 2026

Copy link
Copy Markdown

Bundle Report

Bundle size has no change ✅

@mrwogu
mrwogu merged commit f29b789 into main Oct 1, 2026
29 checks passed
@mrwogu
mrwogu deleted the docs/readme-glossary-link branch October 1, 2026 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant