Skip to content

docs(v1): README tweaks (Console naming, line breaks, PyPI-safe links) - #12

Merged
dani1005 merged 1 commit into
v1from
docs/v1-readme-tweaks
Jul 31, 2026
Merged

docs(v1): README tweaks (Console naming, line breaks, PyPI-safe links)#12
dani1005 merged 1 commit into
v1from
docs/v1-readme-tweaks

Conversation

@dani1005

Copy link
Copy Markdown
Collaborator

Small README polish:

  • Dashboard → Console — the nav link and "get an API key from the EverOS Console", matching the product's name. (The Dashboard is a tab inside the Console; these references mean the product itself.)
  • Line breaks in the "Which package?" and pre-release/upgrade blockquotes — added a blank > line so each renders as two lines instead of one run-on paragraph.
  • Absolute quickstart links — the two quickstart.md links now use the full GitHub URL. Relative links don't resolve on the PyPI project page (no repo context there), so they'd render broken.

README-only; independent of #11.

🤖 Generated with Claude Code

…start links

- Dashboard -> Console (nav link + 'get an API key from the EverOS Console'),
  matching the product name (EverOS Console).
- Force line breaks in the 'Which package?' and pre-release/upgrade blockquotes
  (blank '>' line) so they render as two lines, not one paragraph.
- Point the two quickstart.md links at an absolute GitHub URL — relative links
  don't resolve on the PyPI project page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@dani1005
dani1005 merged commit 4b966a4 into v1 Jul 31, 2026
1 check passed
@dani1005
dani1005 deleted the docs/v1-readme-tweaks branch July 31, 2026 16:28
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