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.

Sign up for GitHub

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

Jump to bottom

docs: Include defradb CLI autogenerated docs v0.5 #95

Merged
merged 3 commits into from
Apr 25, 2023
Merged

docs: Include defradb CLI autogenerated docs v0.5 #95

merged 3 commits into from
Apr 25, 2023

Conversation

orpheuslummis
Copy link
Contributor

@orpheuslummis orpheuslummis commented Apr 18, 2023 •
edited
Loading

Resolves #10

  • script to import from defradb repo and format properly

@orpheuslummis orpheuslummis self-assigned this Apr 18, 2023
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Apr 18, 2023 •
edited
Loading

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 01d2792
Status: ✅  Deploy successful!
Preview URL: https://f7e33983.docs-source-network.pages.dev
Branch Preview URL: https://orpheus-cli-docs.docs-source-network.pages.dev

View logs

@orpheuslummis orpheuslummis mentioned this pull request Apr 25, 2023
Closed
@orpheuslummis orpheuslummis marked this pull request as ready for review April 25, 2023 06:52
@orpheuslummis
Copy link
Contributor Author

to run the script, with e.g. develop commit hash of the moment node scripts/import-defradb-cli-docs.js a0160e0ee9a457255b24afb204be7cb66babd1f2

david-on-github
david-on-github approved these changes Apr 25, 2023
View reviewed changes
Copy link
Member

@david-on-github david-on-github left a comment

Choose a reason for hiding this comment

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

LGTM, wish it was TS :P

Might be helpful to include the command in package.json scripts for convenience.

docs/references/cli/_category_.json Outdated
@@ -0,0 +1,3 @@
{
"label": "CLI"
Copy link
Member

Choose a reason for hiding this comment

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

[Nitpick]: CLI Specification? as per #72

scripts/import-defradb-cli-docs.js
try {
const tempDir = tmp.dirSync({ unsafeCleanup: true });

await git.clone(repoUrl, tempDir.name, { '--depth': 1 });
Copy link
Member

Choose a reason for hiding this comment

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

[Question] What do you think of default to the develop if no sha passed?

@orpheuslummis orpheuslummis merged commit 0507677 into master Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@david-on-github david-on-github david-on-github approved these changes

Assignees

@orpheuslummis orpheuslummis

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Migrate generated CLI documentation
2 participants
@orpheuslummis @david-on-github