Giter VIP home page Giter VIP logo

documenter's Introduction

Repository Analysis

This repository includes scripts that are designed to perform a specific task related to documentation analysis using the OpenAI API. Here's an overview of the main components and functionalities provided:

  • analyze.sh:

    • Analyzes the target directory specified as an argument.
    • Sources environment variables from env.sh, defines the target directory, calls dump-folder.sh to dump the contents of the target directory into a file.
    • Prepares data for an OpenAI API call by formatting JSON and escaping special characters.
    • Calls the OpenAI API with the prepared data and extracts the response.
    • If README.md does not exist in the target directory, it creates one and appends the OpenAI API response in markdown format.
  • dump-folder.sh:

    • Dumps the contents of the provided target directory.
    • Creates a working directory within the target directory.
    • Processes each file in the target directory.
    • Checks for the presence of a .gitignore file and saves the contents of each file in current-folder.txt.
  • env.sh:

    • Contains the environment variable OPENAI_API_KEY required for authorization in the OpenAI API call.

documenter's People

Contributors

sheikkinen avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.