jquery.terminal icon indicating copy to clipboard operation
jquery.terminal copied to clipboard

Create new documentation and new Website

Open jcubic opened this issue 2 years ago • 3 comments

I have an idea for a new feature for jQuery Terminal

The new documentation should include

  • [ ] Introduction
    • [ ] Bash and Linux
    • [ ] JavaScript
    • [ ] jQuery
    • [ ] Not for SSH
  • [ ] Reference (what is what?)
  • [ ] Getting Started guide (simpler and shorter)
  • [ ] Long Tutorial with all the features (Full but gentle introduction)
    • [ ] Everything on the Wiki
    • [ ] Everything on CodePen
    • [ ] Embed CodePen demos
    • [ ] Each feature a single document
  • [ ] Other Demos (not included elsewhere)
  • [ ] API Reference
    • [ ] Update all missing stuff

Website specifics

  • [ ] Interactive Terminal above the fold
    • [x] Basic Terminal
    • [x] github command
    • [x] echo
    • [ ] wikipedia
    • [ ] jargon ?? JSON-RPC hosting Render / flyio
    • [x] Pipe
    • [x] Figlet
    • [ ] xml formatter (without CMD)
    • [ ] matrix full screen with custom font
    • [x] locat
    • [ ] chat
    • [ ] style -c <color> -b <background> -a <animation> -s <size>
    • [ ] help
    • [ ] credits
    • [ ] source command tree
    • [ ] record
    • [x] cowsay
    • [ ] calc
    • [ ] Chunk Norris
    • [ ] Fact
    • [x] joke
    • [ ] Window Games - zoom animation effect
      • [ ] snake
      • [ ] tetris
      • [ ] Rouge
    • [ ] Buttons that exec anim commands
  • [ ] Comments section in Nested interpreter (button trigger exec + animation)
  • [ ] Interactive Terminal should have more features from 404 page
  • [ ] Acknowledge
    • [ ] Project
    • [ ] demos
  • [ ] In The wild (on home page)
  • [ ] Custom 404 page

Unknown

  • [ ] Awesome ASCII
  • [ ] Showcase (unusual and best examples)

Tutorials

  • [ ] Create Terminal based Chat
  • [ ] Hiding commands from users
  • [ ] Cancel AJAX Requests with Abort Signals
  • [ ] Gaiman tutorial
  • [ ] scriptreply (no backspace)
  • [ ]
  • [ ] Adventure Game
  • [ ] Web Worker
  • [ ] JWT
  • [ ] How to create games that run in terminal
    • [ ] "That's the neat part, you don't!" Meme
    • [ ] Rouge
    • [ ] Snake
    • [ ] Tetris
    • [ ] How? Find engine

DevOps

  • [x] Deploy docs to GH pages
  • [x] Disable build when docs change
  • [ ] JSON-RPC: Host Simple Dockerized Web App on fly.io for comments (it can be the same PHP code + SQLite)
  • [ ] Host ANSI art server code
  • [ ] Add GitHub action to build and deploy fly.io
  • [ ] Directory structure
    • [ ] docs
      • [ ] website (docusaurus)
      • [ ] backend (fly.io)

jcubic avatar Jul 03 '22 21:07 jcubic

Maybe I can try Docusaurus, Meta just released version 2.0.

jcubic avatar Aug 05 '22 20:08 jcubic

The repo is located here: jcubic/jquery.terminal-docs.

jcubic avatar Jul 12 '23 18:07 jcubic