Skip to content

Docs cleanup #25

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

Merged
merged 12 commits into from
May 21, 2025
Merged

Docs cleanup #25

merged 12 commits into from
May 21, 2025

Conversation

RensDimmendaal
Copy link
Contributor

This PR adds multiple fixes, mainly to the docs.

  1. Dont run plash_view in index.ipynb as it opens browsers windows when running tests
  2. Add app_id as cli command for ease of use
  3. Rename aid to app_id for consistency
  4. Add gh actions to deploy docs (TODO: add secret to repo)
    • deploy docs on merge
    • deploy docs on PR to a temp url if not made from fork or if PR has label 'docs-preview' (this to prevent abuse)
  5. Several small docstring fixes.
  6. CLI output of app url now supports custom domains
  7. Move the examples folder to the root of the repo

Note: the GH actions needs some testing, hard to do offline.

Copy link

gitnotebooks bot commented May 20, 2025

Found 4 changed notebooks. Review the changes at https://app.gitnotebooks.com/AnswerDotAI/plash_cli/pull/25

@ncoop57 ncoop57 self-requested a review May 21, 2025 18:19
Copy link
Contributor

@ncoop57 ncoop57 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made some minor fixes to cli ref and to the github action for previewing and deploying

@ncoop57 ncoop57 merged commit 7f40813 into main May 21, 2025
1 check passed
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.

2 participants