Closed loicsay closed 9 months ago
@dylantientcheu @clemfromspace
I'm not sure about how we should handle the runInCommand
property for each example ๐ค
Do you have any idea? Should we hardcode a list of commands that allow this feature in the CLI codebase?
For now we can edit the submitted PR each time, i'd prefer not to bloat the cli code.
I think we should run the example directly, so we will have to edit the example to make them match what indices / things we have in the doc. That way, no editing is necessary and it's more coherent maybe. WDYT?
As for the which commands as available, maybe we can tag them in order to exclude / include them from the webCLI? Won't be a big effort IMHO, as we already leverage the tagging for the telemetry & others.
@clemfromspace I agree, let's remove all Examples
formatting for now and do it in new-world-doc
๐
Same for the WebCLI I think? You're suggesting doing outside of this repo if I understand correctly?
@loicsay I saw that you actually removed the example splitting, this was not what I meant ๐
Sorry about the confusion, I wanted to say that we should directly run the examples in the webCLI (for the available commands), but that we should edit those examples, directly in the CLI, to match the indices names & co that are present in the docs. This should be done in a second step, along with adding a availableInWebCLI
annotation on the commands.
cc @kai687 Summary of our discussion with @clemfromspace:
runInWebCli
) to commands with web CLI
enabled in new-world-docs
web CLI
, we'll standardize all examples with the new-world-docs
/webCLI
(in a future PR)
DEX-1021
This PR create a command to generate a
new-world-docs
PR that'll update the.mdx
files for the CLI documentation.How to test?
It will output the files in at
docs/app_data/cli/commands
Refinement
Summary of our discussion with @clemfromspace:
runInWebCli
) to commands withweb CLI
enabled innew-world-docs
web CLI
, we'll standardize all examples with thenew-world-docs
/webCLI
(in a future PR)