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

refactor: make each little thing a linkable heading #30

Merged
merged 10 commits into from
Jan 28, 2024
Merged

refactor: make each little thing a linkable heading #30

merged 10 commits into from
Jan 28, 2024

Conversation

uncenter
Copy link
Member

@uncenter uncenter commented Jan 18, 2024

  • keymap.toml
  • yazi.toml
  • theme.toml
  • Add section explaining the usage of the below content... e.g. for keymap.toml:

There are x "sections" of the keymap.toml file: manager, tasks... TOML stuff... keymap = [ { ... } ].

@sxyazi
Copy link
Member

sxyazi commented Jan 19, 2024

I like the new way of creating anchors for each command. What do you think about placing [manager] and [tasks] in different files so that we can still maintain classification by command type?

1

As for tables, it has some limitations and may prevent the representation of complex structures, such as the parameters of the sort command. Ideally, we should avoid having both lists and tables to keep consistency in content.

@uncenter
Copy link
Member Author

I'm not sure of further separating the pages is a good idea. I've also been thinking about how to maintain that classification and I'm not entirely sure! My feeling is that if they all go under one [section], they shouldn't need further distinction. Maybe we could use more sections/TOML tables?

@sxyazi
Copy link
Member

sxyazi commented Jan 20, 2024

Yeah this is the worst result I had considered to do that. But without sub-categories, we would lose the ability to group similar commands/options together for presentation, something like https://yazi-rs.github.io/docs/configuration/yazi#ueberzug-specific - although it is options rather than commands.

How do you feel about keeping the original format and creating a separate anchor for each command? For example:

<anchor>`escape`</anchor>: Cancel find, exit visual mode, clear selected, cancel filter, or cancel search.

where the anchor component generates a link that can be referenced automatically, such as #manager-escape.

@uncenter
Copy link
Member Author

We could just do a fourth level of headings?

@uncenter
Copy link
Member Author

I think this looks great. The question still remains of how/if we want to maintain the organization / grouping of options within a section... I'm at a loss here.
Screenshot 2024-01-24 at 07 16 15 (Arc)

@sxyazi
Copy link
Member

sxyazi commented Jan 25, 2024

The current issue is not about grouping but about the table.

I just feel that having groups would be better, but I'm not sure if this feeling is suitable - it looks good now, at least better than before, since we can clearly link to a specific command through anchors.

@sxyazi
Copy link
Member

sxyazi commented Jan 25, 2024

For example the rename command, it doesn't seem easy to express through a table:

1

@sxyazi
Copy link
Member

sxyazi commented Jan 28, 2024

Maybe we can merge it first?

@uncenter
Copy link
Member Author

Sorry what do you mean? Merge the conflicts?

@sxyazi
Copy link
Member

sxyazi commented Jan 28, 2024

I'll merge it after resolving the conflict, but first with your approval and change it from draft status to mergeable (it feels weird to merge a draft lol)

@uncenter uncenter marked this pull request as ready for review January 28, 2024 19:00
@uncenter
Copy link
Member Author

Well we probably should deal with the conflicts next, and I should turn the other two pages into tables... then it would be good to merge IMO.

@sxyazi
Copy link
Member

sxyazi commented Jan 28, 2024

Don't turn them into tables yet, I might convert them back to the lists, still need to think about it some more...

@uncenter
Copy link
Member Author

Then we shouldn't merge this yet ahah.

@sxyazi
Copy link
Member

sxyazi commented Jan 28, 2024

That would make conflicts more difficult to address, and I really like the new anchor thing. I hope to see it become a reality soon😆

@uncenter
Copy link
Member Author

Alright, would you like to merge the conflicts? I always mess it up.

@sxyazi sxyazi changed the title refactor: use tables and make each little thing a linkable heading refactor: make each little thing a linkable heading Jan 28, 2024
@sxyazi
Copy link
Member

sxyazi commented Jan 28, 2024

Sure

@sxyazi
Copy link
Member

sxyazi commented Jan 28, 2024

I think I've resolved all the conflicts. Would you like to give it a review?

docs/configuration/keymap.md Outdated Show resolved Hide resolved
docs/configuration/keymap.md Outdated Show resolved Hide resolved
docs/configuration/keymap.md Outdated Show resolved Hide resolved
docs/configuration/keymap.md Show resolved Hide resolved
docs/configuration/keymap.md Outdated Show resolved Hide resolved
docs/configuration/keymap.md Outdated Show resolved Hide resolved
docs/configuration/keymap.md Outdated Show resolved Hide resolved
docs/configuration/keymap.md Outdated Show resolved Hide resolved
@uncenter
Copy link
Member Author

In the future you can add the suggestions to a batch and commit them all at once :)

@sxyazi
Copy link
Member

sxyazi commented Jan 28, 2024

Yeah totally, I forgot about it ahah

@sxyazi sxyazi merged commit 0f87927 into main Jan 28, 2024
@sxyazi
Copy link
Member

sxyazi commented Jan 28, 2024

Thank you, merged!

@sxyazi sxyazi deleted the tables branch January 28, 2024 19:40
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants