{"repo":"DataDog/documentor","free":true,"listed":false,"github":"https://github.com/DataDog/documentor","clone":"git clone https://github.com/DataDog/documentor.git","description":"Improve technical documentation with the power of AI.","language":"Go","stars":35,"topics":["ai","command-line","command-line-tool","documentation","documentation-tool","openai","gpt","llm","anthropic","claude"],"license":"Apache-2.0","category":"cli-tools","readme_excerpt":"documentor documentor is an easy-to-use, efficient, and powerful command-line application that uses the power of AI to review documentation and provide feedback on how to improve it, draft new documentation from scratch, and more. It assists documentation writers in creating better documentation by automating parts of the writing and review process, allowing them to focus on the content and structure of the document itself. Installation From source First, ensure that the following dependencies are installed: - Go 1.24 or above. - make. - scdoc. Optionally, you can install glow to render the Markdown output of the review command with more style. Then, switch to the latest stable tag ( v1.2.0 ), compile, and install: Usage [!NOTE] If you're a Datadog employee, please follow the documentation in Confluence. Examples 1. Review a documentation file using the default provider, OpenAI: 2. Review a documentation file with the API key set in the environment: 3. Save the output to a file: 4. Format the default Markdown output with glow: 5. Describe an image: 6. Describe an image with context: 7. Describe an image and generate a filename for the image: 8. Draft a document based on your notes: 9. Draft a document using Anthropic as the AI provider: 10. Review a document using a different LLM model: Refer to the documentor(1) manpage after installation for more information. Contributing Anyone can help make documentor better. Refer to the contribution guidelines for more information. --- ","default_branch":null,"files":null,"tree":[],"storefront":"/r/DataDog","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/DataDog/documentor/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}