Visit docs.openfn.org to view the documentation site.

Visit https://docs.openfn.org/documentation/writing-docs/.

This website is built using Docusaurus, a static website generator that uses Markdown and Javascript.

• To create new docs pages, add markdown files (or JS files) to the /docs folder.
• To view those new pages via the navigation, add links to them in the header, footer, or sidebars.
• Note that page ids (which are required in sidebar.js are either set explicitly or automatically generated by docusaurus as the filename, sans extension.)

./sidebars.js
./sidebars-adaptors.js
./docusaurs.config.js

asdf install
corepack enable
yarn install

Install nvm-windows. Make sure your node version matches the one specified in .tool-versions.

yarn start

This command builds the Adaptor docs from OpenFn/adaptors, starts a local development server, and opens up a browser window. Most changes are reflected live without having to restart the server.

yarn start-offline

This command skips the adaptor docs step, which requires an active internet connection.

yarn generate-library

This command pulls public job data from OpenFn.org to create a local "job library".

yarn start:dev

Or, if the server is running:

yarn generate-adaptors -m

Ensure that the OPENFN_ADAPTORS_REPO env var is set and points to the local monorepo.

See (github.com/OpenFn/adaptors/wiki/How-to-test-docs-changes)[https://github.com/OpenFn/adaptors/wiki/How-to-test-docs-changes] for more details

yarn generate-adaptors
yarn generate-library
yarn build
yarn serve

This command generates static content into the build directory and can be served using any static contents hosting service.

Builds to main will automatically be deployed to docs.openfn.org. This branch is protected, but we welcome pull requests!