mrwh1te / botmation-docs Goto Github PK

Complete a Tutorial

• Previous/Next Chapter links at the end of a doc file are not properly aligned in mobile. flex-direction:column is applied then, breaking the layout. Maybe submit a PR to the main docs site if the bug exists there?

• npm & github links need to hide in their container and appear in the special mobile header

Low priority, most people reading docs do such from desktop/laptops/tablets over mobile. Also, these bugs are minor, doesn't stop a User from navigating the site

Example code, etc

Replace all embedded instances of code with the existing examples.

Example needs to be made prominent in the page specific navbar (Twitter ie Overview, Install, -->Example<--, Navigation)

Then add a textual link to the repo's code implementation to provide a way to read the replaced embedded instances of code, for those curious.

Table of Contents

Provide examples, TOC, etc for all API docs

Also, add missing Helpers into TOC for each API docs where BotAction type has corresponding Helper file

• Assembly Lines
  • code
  • examples
  • helpers
  • runners
• Console
  • code
  • examples
  • helpers
• Cookies
  • code
  • examples
  • helpers
• Errors
  • code
  • examples
  • helpers
• Files
  • code
  • examples
  • helpers
• IndexedDB
  • code
  • examples
  • helpers
• Inject
  • code
  • examples
  • helpers
• Input
  • code
  • examples
  • helpers
• Local Storage
  • code
  • examples
  • helpers
• Navigation
  • code
  • examples
  • helpers
• Pipe
  • code
  • examples
  • helpers
• Utilities
  • code
  • examples
  • helpers

Go over Botmation's testing setup and strategy, then from there give a template like flow for devs creating tests with strong coverage for their own BotAction's, ie what does unit-tests focus on, what do integration tests mock, what are e2e tests etc

Every doc file has a SEO image meta tag for sharing to fill with either code screenshots related to the file, let's set one for all of a picture of a Bot composed to automate someone's "social account" login() (but don't know who)

https://carbon.now.sh/

• main project source code screenshot for social media sharing

replace doc urls (for both core and auxiliary nav links) like /api/ bot action group with /package name/bot action group

Move the next chapter link for tablet and desktop only, a little bit to the left so as to not be covered by Baby Bot

Not needed in mobile as Baby Bot is then centered

API Docs vertical length could be reduced by consolidating some code examples with their actual code.

A toggle switch between "Code" and "Example" for any API / BotAction|Helper
The code box shows the "code" of a BotAction | Helper in 1st view, and once toggled shows an example usage of said function

Not required for tablet, can be for computers with mouse only

or maybe on tap?

Erase white dots from bottom-right corner Baby bot's eyes. Then overlay white eyes with CSS to "follow the mouse cursor".

Maybe clicking him toggles the effect on/off?

Future:

• Adjust eyelids too for squinting in respect to distance from the mouse cursor
• When off, it could be a sleepy look, or run a schedule of animations, etc.....

Create an image for the Coffee Shop metaphor with people in a line

Can use emoji's

Maybe a comic strip?