Our Documentation Landing Page.
https://docs.robotframework.org/
Links to
- Guides
- User Guide
- Standard Library Documentation
- API Documentation
Find some hints and examples on how to use the Robot Framework.
The Guides helps beginners to get started and advanced users to get new ideas.
https://docs.robotframework.org/docs
This documentation project is powered by Docusaurus and maintained on GitHub
The basic steps to contribute to the project are:
- Fork the project on GitHub
- Clone the repository locally
- Open the repository folder and open the folder
website/
- Install the project dependencies via
npm install
- Update existing documentation files with the new content or add new files
- Run
npm start
to start Development Server to see changes in real time on localhost - Build static html files with
npm run build
- Test the build locally with
npm run serve
- Commit the changes to the repository
- Push the changes to GitHub (only the changed .md files and other static files - Do Not push the built .html files)
- Build and Deployment will be handled by GitHub Actions
Contribute using Gitpod.
No need to install anything locally on your machine.
Enjoy!