Follow these steps to connect your account with the VS Code extension and elevate your documentation workflow.
Copy your integration token and paste it into the EkLine token field in the integration settings. This connects the integration to your account and apply style guide configurations.
Add the paths to your documentation files or folders in the Documentation paths field. Use relative paths like ./docs to ensure EkLine reviews the correct content.
Pick the style guide you want to follow from the dropdown menu. You can choose from Google, Microsoft, Marketing, or set up your own custom guide.
Save your settings to activate the extension. EkLine will automatically review your documentation every time you save a file and provide real-time feedback in the editor.
Using EkLine as part of pull requests has enabled contributions from outside the small docs team at the same time as freeing us up to provide guidance for more substantive improvements.
EkLine is a game-changer for our open source project. Â Now our OSS contributors can use EkLine to check their own PRs and resolve style and grammar issues without maintainer intervention. What used to be a month-long process can now be done self-serve in a few hours without maintainer support.
Once I discovered EkLine, I found ways to integrate it into many projects. It provides many features essential for consistent content sourced from multiple creators.