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

Add command api to docs json #103

Merged
merged 2 commits into from
Nov 6, 2023
Merged

Add command api to docs json #103

merged 2 commits into from
Nov 6, 2023

Conversation

devinhalladay
Copy link
Contributor

I'm not totally sure I'm doing this right, the docs setup is super confusing lol.

@devinhalladay devinhalladay marked this pull request as draft October 26, 2023 16:21
@lunaroyster
Copy link
Contributor

let's jam on this today (monday)

Comment on lines 148 to 159
"typeNames": [
"CommandFnArgs",
"CommandsFn",
"CreateCommand",
"Run",
"SerializableValue",
"BaseCommandArgs",
"ActionCommandArgs",
"ContextCommandArgs",
"CommandArgs",
"CommandProxy"
]
Copy link
Contributor

@lunaroyster lunaroyster Oct 30, 2023

Choose a reason for hiding this comment

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

commandproxy is an implementation detail, removed it

Suggested change
"typeNames": [
"CommandFnArgs",
"CommandsFn",
"CreateCommand",
"Run",
"SerializableValue",
"BaseCommandArgs",
"ActionCommandArgs",
"ContextCommandArgs",
"CommandArgs",
"CommandProxy"
]
"typeNames": [
"CommandFnArgs",
"CommandsFn",
"CreateCommand",
"Run",
"SerializableValue",
"BaseCommandArgs",
"ActionCommandArgs",
"ContextCommandArgs",
"CommandArgs"
]

Copy link
Contributor

@lunaroyster lunaroyster left a comment

Choose a reason for hiding this comment

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

Looks good!

@lafkpages
Copy link
Contributor

lafkpages commented Oct 30, 2023

In these docs it says that the commands API is experimental but I could only get it working via extensionPort.internal. (Maybe I did something wrong though)

@lunaroyster
Copy link
Contributor

did you add the experimental-api scope?

@lunaroyster lunaroyster marked this pull request as ready for review November 6, 2023 12:31
@lunaroyster
Copy link
Contributor

rebased this to pick up docs generation test in CI

@lunaroyster lunaroyster merged commit 098e26f into main Nov 6, 2023
4 checks passed
@lunaroyster lunaroyster deleted the dh-commands-docs branch November 6, 2023 13:09
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.

3 participants