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.

Sign up for GitHub

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

Jump to bottom

📖 Revamp README and docs #339

Closed
12 of 14 tasks
edouard-lopez opened this issue Jan 10, 2024 · 0 comments
Closed
12 of 14 tasks

📖 Revamp README and docs #339

edouard-lopez opened this issue Jan 10, 2024 · 0 comments
Assignees
@edouard-lopez
Labels
🚀 enhancement performance, UX or maintainability 🙏 help wanted needs PR or help on decision

Comments

@edouard-lopez
Copy link
Member

edouard-lopez commented Jan 10, 2024 •
edited
Loading

Todo

  • Improve banner colors
  • migrate doc to mkdocs
    • remove migration quote
    • simplify install instruction
      • only keep fisher instructions
      • extract or collapse manual instructions
    • Restrict 🖌️ Configuration section to explaining how to configure feature/color/symbol
    • Revamp Features, Prompt Symbol and 🔌 Features' Flags to have a feature focus doc
    • Improve 👍 Contribute section
    • Merge 👨‍💻 Maintainer and 👏 Thanks sections
    • Reduce Licence section to title only
    • Extract Colours to another page
  • Publish doc to gh-pages
  • Generate screenshots for each features using https://github.com/OmarTawfik/terminal-screenshot will do in another PR, see docs/revamp documentation and automate screenshots #343

Automatically generate screenshots

Using https://github.com/OmarTawfik/terminal-screenshot

❯ fish_prompt | npx terminal-screenshot --output out.png --background-color white --margin 5

Preview

out
@edouard-lopez edouard-lopez added 🚀 enhancement performance, UX or maintainability 🙏 help wanted needs PR or help on decision labels Jan 10, 2024
edouard-lopez added a commit that referenced this issue Jan 19, 2024
@edouard-lopez
docs: continue migration
50d756b 
fixes #339
edouard-lopez added a commit that referenced this issue Jan 19, 2024
@edouard-lopez
docs: continue migration
62e267f 
fixes #339
edouard-lopez added a commit that referenced this issue Jan 19, 2024
@edouard-lopez
docs: continue migration
556ae61 
fixes #339
edouard-lopez added a commit that referenced this issue Jan 20, 2024
@edouard-lopez
docs(screenshots): setup docker, makefile and tests to automate scree…
c1a6fd5 
…nshot

follows #342
fixes #339
@edouard-lopez edouard-lopez self-assigned this Jan 20, 2024
edouard-lopez added a commit that referenced this issue Jan 23, 2024
@edouard-lopez
docs: continue migration
f0f75f9 
fixes #339
edouard-lopez added a commit that referenced this issue Jan 23, 2024
@edouard-lopez
docs(screenshots): setup docker, makefile and tests to automate scree…
f954f26 
…nshot

follows #342
fixes #339
@edouard-lopez edouard-lopez mentioned this issue Jan 25, 2024
Merged
11 tasks
edouard-lopez added a commit that referenced this issue Jan 25, 2024
@edouard-lopez
docs: continue migration
453d25b 
fixes #339
edouard-lopez added a commit that referenced this issue Jan 25, 2024
@edouard-lopez
docs(screenshots): setup docker, makefile and tests to automate scree…
07958e6 
…nshot

follows #342
fixes #339
edouard-lopez added a commit that referenced this issue Jan 25, 2024
@edouard-lopez
docs(screenshots): setup docker, makefile and tests to automate scree…
c29702e 
…nshot

follows #342
fixes #339
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@edouard-lopez edouard-lopez

Labels
🚀 enhancement performance, UX or maintainability 🙏 help wanted needs PR or help on decision
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@edouard-lopez