-
Notifications
You must be signed in to change notification settings - Fork 404
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
Move command reference to navbar #782
Conversation
Hofer-Julian
commented
Feb 15, 2023
•
edited
Loading
edited
- Move command reference to navbar
- Create one sidebar entry for each category
- Simplify javascript code
- Move command reference to navbar - Create sidebar entries for each category - Simplify javascript code
The command reference is really long at the moment. |
Thanks for this. It seems like a good change. I'm just not sure how to try it out. Is there an easy way to clone the repo and take it for a test drive? |
You can checkout my branch and run If that doesn't work, then I can upload screenshots. |
ok, i just had to do
|
Agreed, I am happy to move the commands to
That is a good point, and that's also what I've tried first. I've re-added the full command output to make sure that this PR at least isn't a regression. |
Thanks, it's really an awesome change. I agree with that we should generate the
$> diff command-reference/bits.md command-reference/bytes.md
1c1
< # Bits
---
> # Bytes
10c10
< .filter(p => p.frontmatter.categories.includes('bits'))
---
> .filter(p => p.frontmatter.categories.includes('bytes')) I think at least we can create all the templates automatically. A much better approach might be create a
export const commandNavs = [
'bits.md',
'bytes.md',
'conversions.md',
'core.md',
'database.md',
'dataframe.md',
'date.md',
'default.md',
'deprecated.md',
'env.md',
'experimental.md',
'expression.md',
'filesystem.md',
'filters.md',
'formats.md',
'generators.md',
'hash.md',
'lazyframe.md',
'math.md',
'misc.md',
'network.md',
'platform.md',
'random.md',
'shells.md',
'strings.md',
'system.md',
'viewers.md',
] then we can
|
Creating the templates with a nu script sounds good to me.
That is a great idea.
I've used
I assume you mean on the Nushell side? |
There are three categories:
I mean on the docs side, I'm not sure whether we should do it on Nushell side or not.
Agree, that's why I think we should merge them in doc nav |
I've installed Nushell with
Not sure if generating categories and merging some of them is the best approach here. |
You can clone the nushell repo and then run |
Regarding this PR, I think what needs to be done is:
I have a preference for working on 2) in a follow-up PR, because I think this PR is already an improvement over the status quo. |
I think we should keep the command docs in |
That's what I would have done, but I am also fine with leaving them where they are. |
Any option is acceptable, maybe move to And do you think |
Fine by me. |
@Hofer-Julian I like the suggestion. I also like |
I've now added the
Any thoughts on this ☝️? |
Yeah, I think we can merge this one. |
LGTM! |
This is some legwork to the CI - [x] fix one `get-row.nu` before 0.60, just because it was easy - [x] `modules/formats/to-ini.nu` - [x] `modules/git/git-v2.nu` - [x] `modules/git/git.nu` - [x] `modules/log/log.nu` - [x] `modules/weather/weatherdark.nu` - [x] `sourced/api_wrappers/worlframalpha.nu` - [x] `sourced/cool-oneliners/pwd-short.nu` - [x] `sourced/github/branch-protections/branch-protections.nu` - [x] `sourced/gitlab/gitlab.nu` - [x] `sourced/misc/nu_defs.nu` - [x] `sourced/update-path.nu` - [x] `sourced/webscraping/shell_starts.nu` I moved some auto-generated commands: - [x] `ack` - [x] `as` - [x] `curl` - [x] `fsarprc` - [x] `fsarpri` - [x] `godoc` - [x] `mysql` - [x] and `xgettext` to custom, so we keep the modifications. I had to comment some of the flags because the parser is not able to parse some flags. Those are explained in comments