Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

qmk docs: restore --port and --browser arguments #24623

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

fauxpark
Copy link
Member

Description

These were removed during the move to Vitepress, however vitepress dev does have equivalent arguments.

Documentation for qmk generate-docs has been tweaked to emphasise it's only for emitting the production docs.

I've also adjusted run_docs_command() to make the dev server interactive, which provides a cleaner way to shut down than hitting Ctrl+C.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@fauxpark fauxpark requested a review from a team November 20, 2024 05:46
@github-actions github-actions bot added documentation cli qmk cli command labels Nov 20, 2024
@fauxpark fauxpark marked this pull request as ready for review November 21, 2024 09:03
Copy link

github-actions bot commented Jan 6, 2025

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

@github-actions github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review cli qmk cli command documentation enhancement python stale Issues or pull requests that have become inactive without resolution.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant