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

Better Cheat Sheet Layout #717

Open
coolaj86 opened this issue Oct 28, 2023 · 0 comments
Open

Better Cheat Sheet Layout #717

coolaj86 opened this issue Oct 28, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@coolaj86
Copy link
Member

coolaj86 commented Oct 28, 2023

After the most recent "Files" section updates, I realized that it pushes the Cheat Sheet down below the fold in many cases (such as laptop screens).

That can lead to loss of value.

I think we ought to switch it up:

  • Special install instructions
  • Cheat Sheet
    • Blurb (or maybe even move this up)
    • Golden One-Liner
    • Image
  • Table of Contents
  • Files
  • How to x
  • ...

Example

Install x

curl https://webi.sh/x | sh

Windows users

It's gonna hurt. Do this:

echo "take some advil"

Cheat Sheet

engaging blurb

To install or update x, run webi x@stable or webi x@2, etc.

x --amaze

Table of Contents

  • Files
  • Config X
  • Do Y
  • System Service

Files

These are the files that may be modified with this install:

~/.local/bin/webi
~/.config/envman/PATH.env
~/.config/x/config.json
~/.local/opt/x/
<PROJECT-DIR>/conf.x

How to Configure X

Do the thing with the stuff

do:
    - thing: with
      the: stuff
      and:
        - more
        - and
        - more

How to do X

...

@coolaj86 coolaj86 added enhancement New feature or request documentation Improvements or additions to documentation labels Oct 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant