Skip to content

docs: add keymaps section and point to configuration page after install #827

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

horriblename
Copy link
Collaborator

  • docs: typo
  • docs: add section on keymaps in configuring.md

Sanity Checking

  • I have updated the changelog as per my changes
  • I have tested, and self-reviewed my code
  • My changes fit guidelines found in hacking nvf
  • Style and consistency
    • I ran Alejandra to format my code (nix fmt)
    • My code conforms to the editorconfig configuration of the project
    • My changes are consistent with the rest of the codebase
  • If new changes are particularly complex:
    • My code includes comments in particularly complex areas
    • I have added a section in the manual
    • (For breaking changes) I have included a migration guide
  • Package(s) built:
    • .#nix (default package)
    • .#maximal
    • .#docs-html (manual, must build)
    • .#docs-linkcheck (optional, please build if adding links)
  • Tested on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin

Add a 👍 reaction to pull requests you find important.

github-actions bot pushed a commit that referenced this pull request Apr 13, 2025
Copy link

github-actions bot commented Apr 13, 2025

🚀 Live preview deployed from fc6c116

View it here:

Debug Information

Triggered by: horriblename

HEAD at: docs-keymaps

Reruns: 736

github-actions bot pushed a commit that referenced this pull request Apr 21, 2025
@NotAShelf NotAShelf changed the title docs keymaps docs: mention keymaps section Apr 21, 2025
@horriblename horriblename force-pushed the docs-keymaps branch 2 times, most recently from a0bff74 to 545613c Compare April 22, 2025 18:10
github-actions bot pushed a commit that referenced this pull request Apr 22, 2025
github-actions bot pushed a commit that referenced this pull request Apr 25, 2025
@horriblename horriblename changed the title docs: mention keymaps section docs: add keymaps section and point to configuration page after install Apr 25, 2025
@horriblename
Copy link
Collaborator Author

added note blocks that point to the configuring page right after every installation method - lets users see clearly what the next step is, regardless of what installation method they follow

@NotAShelf
Copy link
Owner

Looks good. I was considering something similar myself.

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.

2 participants