search

webrecorder / behaviors

Webrecorder Automated In-Page Behavior Framework
GNU Affero General Public License v3.0
12 stars 6 forks source link

Improving the workflow for new contributors #67

Open sedmonds opened 4 years ago

sedmonds commented 4 years ago

I reviewed the current documentation and suggest the creation of a better 'Getting Started' and 'Using Autopilot' chapters in proposed Autopilot manual.

Chapter 1: Getting Started What is Web archiving? Why Autopilot? Installing Autopilot? Autopilot Basics About Web Traffic Status Page: Pre-made Behaviors

Chapter 2: Using Autopilot Creating Your First Behavior [For beginner the dev/user] Testing Your First Behavior Fixing a Broken Behavior Checking Behavior Status ...

Chapter 3: Hacking Autopilot [For advanced devs: current documentation] Contributing to Autopilot Tools of the Trade Creating a Behavior Testing a Behavior (Debugging) Behaviors Build System CLI Overview on behaviors Provided cli commands Behavior standard library reference ...

Chapter 4: Behind Autopilot Maintainers Contact Support Discussion Forum Who Uses Autopilot? ...

Reference: API CBehaviorRunner CMutationStream FinitRunnableBehavior FcreateState FstateWithMsgNoWait FstateWithMsgWait FstateWithMsgWaitFromAwaitable FstateWithMsgWaitFromFn FbrowserHistoryGoBack FbrowserLocation FlocationContains FlocationEquals FwaitForHistoryManipToChangeLocation Fclick FclickAndWaitFor FclickAndWaitForHistoryChange FclickInContext FclickInContextWithDelay FclickWithDelay FscrollAllIntoViewAndClick FscrollAllIntoViewAndClickWithDelay FchainQs FchildElementIterator FchildNodeIterator ...

FAQ Is Autopilot open source? What does Autopilot cost? What platforms does Autopilot run on? How can I contribute to Autopilot? Glossary of Terms