mrwh1te / botmation-docs Goto Github PK
View Code? Open in Web Editor NEWGatsby based Documentation website for the TypeScript library Botmation
License: MIT License
Gatsby based Documentation website for the TypeScript library Botmation
License: MIT License
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:
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
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)
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
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
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
Table of Contents
replace doc urls (for both core and auxiliary nav links) like /api/ bot action group
with /package name/bot action group
Create an image for the Coffee Shop metaphor with people in a line
Can use emoji's
Maybe a comic strip?
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.
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
Example code, etc
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.