diff --git a/docs/docs/examples/archive/readme-mlops.md b/docs/docs/examples/archive/readme-mlops.md index 28aacda9..6b450039 100644 --- a/docs/docs/examples/archive/readme-mlops.md +++ b/docs/docs/examples/archive/readme-mlops.md @@ -137,7 +137,7 @@ The mlops-course project automates model training and hyperparameter tuning for | File | Summary | | --- | --- | | [cluster_env.yaml](https://github.com/GokuMohandas/mlops-course/blob/master/deploy/cluster_env.yaml) | Configure cluster computing environment for Ray with post-build Python package installations. | -| [cluster_compute.yaml](https://github.com/GokuMohandas/mlops-course/blob/master/deploy/cluster_compute.yaml) | Manages cloud resources for madewithml deployment in us-east2, specifying head and worker node types with their configurations.Intialized BlockDeviceMappings and TagSpecifications. | +| [cluster_compute.yaml](https://github.com/GokuMohandas/mlops-course/blob/master/deploy/cluster_compute.yaml) | Manages cloud resources for madewithml deployment in us-east2, specifying head and worker node types with their configurations.Initialized BlockDeviceMappings and TagSpecifications. | diff --git a/docs/docs/examples/archive/readme-ollama.md b/docs/docs/examples/archive/readme-ollama.md index f575b999..297cb253 100644 --- a/docs/docs/examples/archive/readme-ollama.md +++ b/docs/docs/examples/archive/readme-ollama.md @@ -147,7 +147,7 @@ | --- | --- | | [coverage.yml](https://github.com/eli64s/readme-ai/blob/master/.github/workflows/coverage.yml) | The.github/workflows/coverage.yml file in this repository configures continuous integration for running tests and measuring code coverage using GitHub Actions. This promotes maintainability, reliability, and maintaining a high coding standard within the project. | | [release-pipeline.yml](https://github.com/eli64s/readme-ai/blob/master/.github/workflows/release-pipeline.yml) | The `release-pipeline.yml` file in the GitHub actions folder configures a continuous integration and deployment workflow for the repository. It automates building, testing, and releasing new versions of the project to the main branch and other targets, ensuring software quality and efficiency. | -| [release-drafter.yml](https://github.com/eli64s/readme-ai/blob/master/.github/workflows/release-drafter.yml) | The `release-drafter.yml` file in the repositorys.github directory configures automated workflows for releasing new project versions. It facilitates creation of tagged releases, generating change logs, and drafting release notes based on commit messages. | +| [release-drafter.yml](https://github.com/eli64s/readme-ai/blob/master/.github/workflows/release-drafter.yml) | The `release-drafter.yml` file in the repositories.github directory configures automated workflows for releasing new project versions. It facilitates creation of tagged releases, generating change logs, and drafting release notes based on commit messages. | @@ -309,7 +309,7 @@ | File | Summary | | --- | --- | -| [tree.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/generators/tree.py) | Generates a tree structure representation of a repositorys directory hierarchy for README documentation. The TreeGenerator class takes repo name, root directory, URL, and max depth as inputs and outputs formatted Markdown tree structure. (60 tokens) | +| [tree.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/generators/tree.py) | Generates a tree structure representation of a repositories directory hierarchy for README documentation. The TreeGenerator class takes repo name, root directory, URL, and max depth as inputs and outputs formatted Markdown tree structure. (60 tokens) | | [builder.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/generators/builder.py) | The `readmeai/generators/builder.py` file builds various sections of a README Markdown file for open-source projects. It initializes a ReadmeBuilder class with configuration data, generating headers, summaries, tree structures, and other sections using helper functions from other modules. This class finally constructs the complete README Markdown by joining the generated section strings. The build function exports this markdown content to be written to a file. | | [utils.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/generators/utils.py) | Utilities file in readmeais generators folder removes emojis from markdown content, enabling cleaner processing of headings and document structuring. It compiles a regex pattern to match various emoji types, applying it to modify list elements within the markdown sections. | | [badges.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/generators/badges.py) | This Python file, located in readmeai/generators/badges.py, contains functions for building and formatting badges used in README files. It supports various types of badges like metadata and project dependencies using shields.io or skill icons from the skill-icons repository. The formatted badges can be aligned as per the config settings. | diff --git a/docs/docs/examples/archive/readme-python-v0.5.87.md b/docs/docs/examples/archive/readme-python-v0.5.87.md index cf636489..760ef184 100644 --- a/docs/docs/examples/archive/readme-python-v0.5.87.md +++ b/docs/docs/examples/archive/readme-python-v0.5.87.md @@ -5,7 +5,7 @@

README-AI

- Automated README documenation generator! + Automated README documentation generator!

license @@ -172,7 +172,7 @@ The `readme-ai` project is an automated README generator leveraging AI to synthe | File | Summary | | --- | --- | -| [ansible.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/configuration/ansible.py) | Parse Ansible configuration files for repositorys AI project. | +| [ansible.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/configuration/ansible.py) | Parse Ansible configuration files for repositories AI project. | | [properties.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/configuration/properties.py) | Parser for.properties configuration files extracting connection strings and package names. | | [apache.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/configuration/apache.py) | Parser for Apache configuration files in the `readme-ai` repository. | | [docker.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/configuration/docker.py) | Parser for Docker configuration files extracting package names from Dockerfile and services from docker-compose.yaml. | @@ -226,7 +226,7 @@ The `readme-ai` project is an automated README generator leveraging AI to synthe | File | Summary | | --- | --- | -| [composer.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/package/composer.py) | Parse PHP Composer configuration files for repositorys architecture. | +| [composer.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/package/composer.py) | Parse PHP Composer configuration files for repositories architecture. | | [npm.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/package/npm.py) | Parse npm and yarn.lock files to extract dependencies for documentation generation. | | [gradle.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/package/gradle.py) | Parser for extracting package names from Gradle dependency files. | | [nuget.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/package/nuget.py) | Parser for NuGet.Config files in.NET, located in readmeai/parsers/package/nuget.py. | diff --git a/docs/docs/examples/archive/readme-readmeai.md b/docs/docs/examples/archive/readme-readmeai.md index 935f8fc5..58cdfc3c 100644 --- a/docs/docs/examples/archive/readme-readmeai.md +++ b/docs/docs/examples/archive/readme-readmeai.md @@ -126,7 +126,7 @@ README-AI is an innovative open-source project that leverages AI models to autom | [Dockerfile](https://github.com/eli64s/readme-ai/blob/main/Dockerfile) | Builds a Docker image for the readmeai package, setting up a non-root user, installing dependencies, and configuring the environment. The image runs the readmeai CLI by default. | | [Makefile](https://github.com/eli64s/readme-ai/blob/main/Makefile) | Manages repository cleanup, formatting, linting, and testing tasks.-Builds Conda package, generates requirements file, and searches for a word in the directory.-Executes various commands for maintaining code quality and project organization. | | [pyproject.toml](https://github.com/eli64s/readme-ai/blob/main/pyproject.toml) | Generates README files using AI models. Key features include markdown generation, badge integration, and AI-powered content creation. Supports Python, markdown, and various AI libraries. | -| [noxfile.py](https://github.com/eli64s/readme-ai/blob/main/noxfile.py) | Executes tests across multiple Python versions by installing the package and running the test suite with coverage reports. The code ensures seamless testing workflow for the repositorys Python versions. | +| [noxfile.py](https://github.com/eli64s/readme-ai/blob/main/noxfile.py) | Executes tests across multiple Python versions by installing the package and running the test suite with coverage reports. The code ensures seamless testing workflow for the repositories Python versions. | @@ -144,7 +144,7 @@ README-AI is an innovative open-source project that leverages AI models to autom | File | Summary | | --- | --- | -| [parsers](https://github.com/eli64s/readme-ai/blob/main/tests/parsers) | Validates data parsing functionality ensuring accurate extraction and transformation. Enhances data integrity and reliability within the repositorys architecture. | +| [parsers](https://github.com/eli64s/readme-ai/blob/main/tests/parsers) | Validates data parsing functionality ensuring accurate extraction and transformation. Enhances data integrity and reliability within the repositories architecture. | @@ -213,7 +213,7 @@ README-AI is an innovative open-source project that leverages AI models to autom | [cpp.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/cpp.py) | CMakeParser for CMakeLists.txt, ConfigureAcParser for configure.ac, and MakefileAmParser for Makefile.am. Each parser handles specific file types to identify dependencies, libs, and software. | | [swift.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/swift.py) | Extracts Swift package names from Package.swift files by parsing dependencies. | | [python.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/python.py) | Parses Python dependency files to extract package names without version specifiers.-Handles requirements.txt, TOML (Pipenv, Poetry, Flit), and YAML (environment.yml) formats.-Ensures robust error handling for parsing exceptions. | -| [go.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/go.py) | Extracts Go package dependencies from go.mod files using regex pattern matching. Inherits from BaseFileParser to parse content and handle parsing errors. Contributes to the repositorys parsers module for language-specific file parsing. | +| [go.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/go.py) | Extracts Go package dependencies from go.mod files using regex pattern matching. Inherits from BaseFileParser to parse content and handle parsing errors. Contributes to the repositories parsers module for language-specific file parsing. | | [rust.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/rust.py) | Extracts Rust package names from cargo.toml files using toml parsing library. | @@ -225,7 +225,7 @@ README-AI is an innovative open-source project that leverages AI models to autom | [bitbucket.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/bitbucket.py) | Extracts Bitbucket Pipelines configuration details for CI/CD workflows. | | [travis.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/travis.py) | Extracts CI/CD configurations from.travis.yml files. | | [gitlab.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/gitlab.py) | Extracts GitLab CI configuration details from.gitlab-ci.yml files. | -| [jenkins.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/jenkins.py) | Extracts Jenkinsfile configurations for CI/CD pipelines. Identifies and parses Jenkinsfile settings for automation and deployment processes within the repositorys architecture. | +| [jenkins.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/jenkins.py) | Extracts Jenkinsfile configurations for CI/CD pipelines. Identifies and parses Jenkinsfile settings for automation and deployment processes within the repositories architecture. | | [github.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/github.py) | Extracts GitHub Actions configurations for CI/CD pipelines from.github/workflows/ directory. | | [circleci.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/circleci.py) | Parses CircleCI configuration files in the readme-ai repository. | @@ -253,11 +253,11 @@ README-AI is an innovative open-source project that leverages AI models to autom | File | Summary | | --- | --- | | [composer.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/composer.py) | Extracts PHP Composer configuration details from composer.json files. | -| [npm.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/npm.py) | Extracts dependencies from package.json and yarn.lock files for the parent repositorys architecture. Parses JSON dependency files and yarn.lock files to retrieve package names for different sections. | +| [npm.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/npm.py) | Extracts dependencies from package.json and yarn.lock files for the parent repositories architecture. Parses JSON dependency files and yarn.lock files to retrieve package names for different sections. | | [gradle.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/gradle.py) | Parses Gradle dependency files to extract package names. Handles both build.gradle and build.gradle.kts formats, utilizing regex patterns for parsing. Implements error handling for parsing exceptions. | | [nuget.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/nuget.py) | Parses NuGet.Config files for.NET configuration settings. | | [yarn.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/yarn.py) | Extracts package names from a yarn.lock file using regex pattern matching. | -| [pip.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/pip.py) | Extracts and interprets Pip configuration files for the parent repositorys AI documentation tool. | +| [pip.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/pip.py) | Extracts and interprets Pip configuration files for the parent repositories AI documentation tool. | | [maven.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/maven.py) | Extracts Maven package names from pom.xml files, handling parsing errors. Parses groupId, artifactId, and version using regex. Appends spring if found in dependencies. Returns a set of unique dependencies. | | [gem.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/gem.py) | Parses Gemfile.lock (Ruby) configuration files in the readme-ai repository. | diff --git a/docs/docs/examples/archive/readme-sqlmesh.md b/docs/docs/examples/archive/readme-sqlmesh.md index 493dc155..61c9481b 100644 --- a/docs/docs/examples/archive/readme-sqlmesh.md +++ b/docs/docs/examples/archive/readme-sqlmesh.md @@ -110,7 +110,7 @@ The sqlmesh-test-tools project is designed to enhance the reliability and effici | File | Summary | | --- | --- | | [sqlmesh_yml_generator.ipynb](https://github.com/eli64s/sqlmesh-test-tools/blob/main/notebooks/sqlmesh_yml_generator.ipynb) | Generates YAML configuration files for SQL unit tests by parsing SQL queries, executing them against a dataset, and outputting the results in a structured format to facilitate automated testing within the SQLMesh testing framework. This enhances the reliability of SQL data models by automating test validations. | -| [faker_dataset_generator.ipynb](https://github.com/eli64s/sqlmesh-test-tools/blob/main/notebooks/faker_dataset_generator.ipynb) | Generates synthetic datasets for testing SQL queries by leveraging the Faker library to produce realistic loan and restaurant service data, which are then saved as CSV files for integration into automated testing workflows within the repositorys SQL testing framework. | +| [faker_dataset_generator.ipynb](https://github.com/eli64s/sqlmesh-test-tools/blob/main/notebooks/faker_dataset_generator.ipynb) | Generates synthetic datasets for testing SQL queries by leveraging the Faker library to produce realistic loan and restaurant service data, which are then saved as CSV files for integration into automated testing workflows within the repositories SQL testing framework. | @@ -127,7 +127,7 @@ The sqlmesh-test-tools project is designed to enhance the reliability and effici | File | Summary | | --- | --- | -| [test_metric_loans_model.sql](https://github.com/eli64s/sqlmesh-test-tools/blob/main/sql/test_metric_loans_model.sql) | Analyzes loan data by computing metrics such as average loan amount, age demographics of applicants, and loan frequency within the year, integrating these insights through a series of joined SQL queries to facilitate comprehensive data-driven decision-making within the repositorys testing framework. | +| [test_metric_loans_model.sql](https://github.com/eli64s/sqlmesh-test-tools/blob/main/sql/test_metric_loans_model.sql) | Analyzes loan data by computing metrics such as average loan amount, age demographics of applicants, and loan frequency within the year, integrating these insights through a series of joined SQL queries to facilitate comprehensive data-driven decision-making within the repositories testing framework. | diff --git a/docs/docs/examples/archive/readme-typescript.md b/docs/docs/examples/archive/readme-typescript.md index 471c6a4f..2a05afc4 100644 --- a/docs/docs/examples/archive/readme-typescript.md +++ b/docs/docs/examples/archive/readme-typescript.md @@ -102,7 +102,7 @@ The ChatGPT-App-React-Native-TypeScript project is a mobile application built wi ├── package.json ├── screens │ ├── HomeScreen.tsx - │ └── Infomation.tsx + │ └── Information.tsx ├── server │ ├── .gitignore │ ├── config.js @@ -169,7 +169,7 @@ The ChatGPT-App-React-Native-TypeScript project is a mobile application built wi | File | Summary | | --- | --- | -| [Infomation.tsx](https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript/blob/master/screens/Infomation.tsx) | Displays an Infomation screen layout using React Native, presenting centered text within a container. | +| [Information.tsx](https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript/blob/master/screens/Information.tsx) | Displays an Information screen layout using React Native, presenting centered text within a container. | | [HomeScreen.tsx](https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript/blob/master/screens/HomeScreen.tsx) | Compose the HomeScreen component; integrates ListMessage and InputMessage within a Layout, key to the ChatGPT-App-React-Native-TypeScript architecture. | diff --git a/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Python.md b/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Python.md index dc400ff2..b443ab66 100644 --- a/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Python.md +++ b/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Python.md @@ -349,7 +349,7 @@ This project requires the following dependencies: ### 🔷 Installation -Build splitme-ai from the source and intsall dependencies: +Build splitme-ai from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Streamlit.md b/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Streamlit.md index e788a481..f386b39c 100644 --- a/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Streamlit.md +++ b/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Streamlit.md @@ -196,7 +196,7 @@ This project requires the following dependencies: ### 🟤 Installation -Build readme-ai-streamlit from the source and intsall dependencies: +Build readme-ai-streamlit from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Vercel.md b/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Vercel.md index 76529394..25bb1454 100644 --- a/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Vercel.md +++ b/docs/docs/examples/models/anthropic/claude-3-sonnet/README-Vercel.md @@ -291,7 +291,7 @@ This project requires the following dependencies: ### 🟤 Installation -Build github-readme-quotes from the source and intsall dependencies: +Build github-readme-quotes from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-chatgpt-app-react-native-typescript.md b/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-chatgpt-app-react-native-typescript.md index 0f53bcc1..9d34f34f 100644 --- a/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-chatgpt-app-react-native-typescript.md +++ b/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-chatgpt-app-react-native-typescript.md @@ -110,7 +110,7 @@ This project accelerates the creation of sophisticated AI chat applications. The ├── package.json ├── screens │ ├── HomeScreen.tsx - │ └── Infomation.tsx + │ └── Information.tsx ├── server │ ├── .gitignore │ ├── config.js @@ -244,7 +244,7 @@ This project accelerates the creation of sophisticated AI chat applications. The - Infomation.tsx + Information.tsx - Defines the Information screen component for a React Native application
- Renders a simple view with centered text displaying Information
- Utilizes React Native's StyleSheet for basic styling
- As part of the screens directory, this component likely serves as a standalone page or section within the app's navigation structure, potentially providing user information or app details. @@ -340,7 +340,7 @@ This project requires the following dependencies: ### ② Installation -Build ChatGPT-App-React-Native-TypeScript from the source and intsall dependencies: +Build ChatGPT-App-React-Native-TypeScript from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-docker-gs-ping.md b/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-docker-gs-ping.md index 14fb08bf..1056705e 100644 --- a/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-docker-gs-ping.md +++ b/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-docker-gs-ping.md @@ -181,7 +181,7 @@ This project requires the following dependencies: ### 🎋 Installation -Build docker-gs-ping from the source and intsall dependencies: +Build docker-gs-ping from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-mlops-course.md b/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-mlops-course.md index dde0b05f..039f5918 100644 --- a/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-mlops-course.md +++ b/docs/docs/examples/models/anthropic/claude-3-sonnet/readme-mlops-course.md @@ -395,7 +395,7 @@ This project requires the following dependencies: ### 🌀 Installation -Build mlops-course from the source and intsall dependencies: +Build mlops-course from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/google/gemini-1.5-flash/README-Streamlit.md b/docs/docs/examples/models/google/gemini-1.5-flash/README-Streamlit.md index c8fe0ba1..ac3d919d 100644 --- a/docs/docs/examples/models/google/gemini-1.5-flash/README-Streamlit.md +++ b/docs/docs/examples/models/google/gemini-1.5-flash/README-Streamlit.md @@ -248,7 +248,7 @@ This project requires the following dependencies: ### ◾ Installation -Build readme-ai-streamlit from the source and intsall dependencies: +Build readme-ai-streamlit from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/ollama/llama3/readme-badgie.md b/docs/docs/examples/models/ollama/llama3/readme-badgie.md index ba2123da..2dab2937 100644 --- a/docs/docs/examples/models/ollama/llama3/readme-badgie.md +++ b/docs/docs/examples/models/ollama/llama3/readme-badgie.md @@ -288,7 +288,7 @@ This project requires the following dependencies: ### 🟤 Installation -Build badgie from the source and intsall dependencies: +Build badgie from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/ollama/llama3/readme-callmon.md b/docs/docs/examples/models/ollama/llama3/readme-callmon.md index 16337043..7c843005 100644 --- a/docs/docs/examples/models/ollama/llama3/readme-callmon.md +++ b/docs/docs/examples/models/ollama/llama3/readme-callmon.md @@ -305,7 +305,7 @@ This project requires the following dependencies: ### 🎋 Installation -Build CallMon from the source and intsall dependencies: +Build CallMon from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/ollama/llama3/readme-chatgpt-app-react-native-typescript.md b/docs/docs/examples/models/ollama/llama3/readme-chatgpt-app-react-native-typescript.md index a4b18192..a3ded66c 100644 --- a/docs/docs/examples/models/ollama/llama3/readme-chatgpt-app-react-native-typescript.md +++ b/docs/docs/examples/models/ollama/llama3/readme-chatgpt-app-react-native-typescript.md @@ -136,7 +136,7 @@ This project empowers developers to build robust messaging applications with eas App.tsx - - Establishes the core architecture of the application, defining a navigation stack that handles multiple screens with distinct layouts and titles
- The App component acts as the entry point, providing context to the entire app through the DataProvider
- It sets up a navigation framework, allowing seamless transitions between the Home Screen and Infomation Screen. + - Establishes the core architecture of the application, defining a navigation stack that handles multiple screens with distinct layouts and titles
- The App component acts as the entry point, providing context to the entire app through the DataProvider
- It sets up a navigation framework, allowing seamless transitions between the Home Screen and Information Screen. @@ -239,8 +239,8 @@ This project empowers developers to build robust messaging applications with eas - Infomation.tsx - - Displays information to the user with a centered text component
- This feature is part of the applications UI and provides essential data to users
- The Infomation component utilizes react-native elements, such as Text, View, and SliderComponent
- It contributes significantly to the overall usability experience of the app. + Information.tsx + - Displays information to the user with a centered text component
- This feature is part of the applications UI and provides essential data to users
- The Information component utilizes react-native elements, such as Text, View, and SliderComponent
- It contributes significantly to the overall usability experience of the app. HomeScreen.tsx @@ -335,7 +335,7 @@ This project requires the following dependencies: ### 💫 Installation -Build ChatGPT-App-React-Native-TypeScript from the source and intsall dependencies: +Build ChatGPT-App-React-Native-TypeScript from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/ollama/llama3/readme-docker-gs-ping.md b/docs/docs/examples/models/ollama/llama3/readme-docker-gs-ping.md index 7103b487..c83867d1 100644 --- a/docs/docs/examples/models/ollama/llama3/readme-docker-gs-ping.md +++ b/docs/docs/examples/models/ollama/llama3/readme-docker-gs-ping.md @@ -189,7 +189,7 @@ This project requires the following dependencies: ### 🔷 Installation -Build docker-gs-ping from the source and intsall dependencies: +Build docker-gs-ping from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/ollama/llama3/readme-file-io-android-client.md b/docs/docs/examples/models/ollama/llama3/readme-file-io-android-client.md index 0f9a5f86..080744ce 100644 --- a/docs/docs/examples/models/ollama/llama3/readme-file-io-android-client.md +++ b/docs/docs/examples/models/ollama/llama3/readme-file-io-android-client.md @@ -676,7 +676,7 @@ This project requires the following dependencies: ### 🌱 Installation -Build file.io-Android-Client from the source and intsall dependencies: +Build file.io-Android-Client from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/ollama/llama3/readme-minimal-todo.md b/docs/docs/examples/models/ollama/llama3/readme-minimal-todo.md index 81449511..893360d5 100644 --- a/docs/docs/examples/models/ollama/llama3/readme-minimal-todo.md +++ b/docs/docs/examples/models/ollama/llama3/readme-minimal-todo.md @@ -534,7 +534,7 @@ This project requires the following dependencies: ### 🔷 Installation -Build Minimal-Todo from the source and intsall dependencies: +Build Minimal-Todo from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/ollama/llama3/readme-mlops-course.md b/docs/docs/examples/models/ollama/llama3/readme-mlops-course.md index fbe2156d..35875d97 100644 --- a/docs/docs/examples/models/ollama/llama3/readme-mlops-course.md +++ b/docs/docs/examples/models/ollama/llama3/readme-mlops-course.md @@ -352,7 +352,7 @@ This project requires the following dependencies: ### 🔷 Installation -Build mlops-course from the source and intsall dependencies: +Build mlops-course from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/ollama/llama3/readme-pydantic-ai.md b/docs/docs/examples/models/ollama/llama3/readme-pydantic-ai.md index 83d926ba..d1ac4075 100644 --- a/docs/docs/examples/models/ollama/llama3/readme-pydantic-ai.md +++ b/docs/docs/examples/models/ollama/llama3/readme-pydantic-ai.md @@ -574,7 +574,7 @@ This project requires the following dependencies: ### ⚡ Installation -Build pydantic-ai from the source and intsall dependencies: +Build pydantic-ai from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/ollama/llama3/readme-readme-ai-streamlit.md b/docs/docs/examples/models/ollama/llama3/readme-readme-ai-streamlit.md index db54bf6b..dea9d28d 100644 --- a/docs/docs/examples/models/ollama/llama3/readme-readme-ai-streamlit.md +++ b/docs/docs/examples/models/ollama/llama3/readme-readme-ai-streamlit.md @@ -205,7 +205,7 @@ This project requires the following dependencies: ### 💫 Installation -Build readme-ai-streamlit from the source and intsall dependencies: +Build readme-ai-streamlit from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/ollama/llama3/readme-readme-ai.md b/docs/docs/examples/models/ollama/llama3/readme-readme-ai.md index 6b7aeba5..54013aa7 100644 --- a/docs/docs/examples/models/ollama/llama3/readme-readme-ai.md +++ b/docs/docs/examples/models/ollama/llama3/readme-readme-ai.md @@ -858,7 +858,7 @@ IX. [👏 Acknowledgments](#-acknowledgments)
tree.py - - Generates Directory Structure for Code Repository**The tree.py file provides a class, TreeGenerator, to build a string representation of a directory structure
- It generates a hierarchical tree view of a code repositorys directories and subdirectories based on the provided repository name, root directory, and maximum depth
- The generated tree structure is formatted with indentation for better readability. + - Generates Directory Structure for Code Repository**The tree.py file provides a class, TreeGenerator, to build a string representation of a directory structure
- It generates a hierarchical tree view of a code repositories directories and subdirectories based on the provided repository name, root directory, and maximum depth
- The generated tree structure is formatted with indentation for better readability. emojis.py @@ -908,7 +908,7 @@ IX. [👏 Acknowledgments](#-acknowledgments)
metadata.py - - Retrieves metadata of a git repository via the host providers API, providing detailed information about the repositorys statistics, details, and settings
- Fetches GitHub repository metadata using an aiohttp ClientSession, parsing raw data into a structured dataclass
- Returns RepositoryMetadata object with comprehensive repository info or None if an error occurs during fetching. + - Retrieves metadata of a git repository via the host providers API, providing detailed information about the repositories statistics, details, and settings
- Fetches GitHub repository metadata using an aiohttp ClientSession, parsing raw data into a structured dataclass
- Returns RepositoryMetadata object with comprehensive repository info or None if an error occurs during fetching. providers.py @@ -969,7 +969,7 @@ This project requires the following dependencies: ### 🛠️ Installation -Build readme-ai from the source and intsall dependencies: +Build readme-ai from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-DockerGo.md b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-DockerGo.md index 0bfcc2f8..9ab3d90a 100644 --- a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-DockerGo.md +++ b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-DockerGo.md @@ -187,7 +187,7 @@ This project requires the following dependencies: ### 🟤 Installation -Build docker-gs-ping from the source and intsall dependencies: +Build docker-gs-ping from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-FastAPI.md b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-FastAPI.md index 39f1b09a..2341b6ee 100644 --- a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-FastAPI.md +++ b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-FastAPI.md @@ -324,7 +324,7 @@ This project requires the following dependencies: ### 🛠️ Installation -Build async-ml-inference from the source and intsall dependencies: +Build async-ml-inference from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Java.md b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Java.md index e0d4e0d4..d36b7cae 100644 --- a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Java.md +++ b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Java.md @@ -543,7 +543,7 @@ This project requires the following dependencies: ### ◾ Installation -Build Minimal-Todo from the source and intsall dependencies: +Build Minimal-Todo from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Kotlin.md b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Kotlin.md index d777878d..aa83cff8 100644 --- a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Kotlin.md +++ b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Kotlin.md @@ -694,7 +694,7 @@ This project requires the following dependencies: ### ⚡ Installation -Build file.io-Android-Client from the source and intsall dependencies: +Build file.io-Android-Client from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-MLOps.md b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-MLOps.md index 32eb4a97..11a5ed87 100644 --- a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-MLOps.md +++ b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-MLOps.md @@ -354,7 +354,7 @@ This project requires the following dependencies: ### 🔷 Installation -Build mlops-course from the source and intsall dependencies: +Build mlops-course from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Postgresql.md b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Postgresql.md index b6d33d21..be580bff 100644 --- a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Postgresql.md +++ b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Postgresql.md @@ -361,7 +361,7 @@ This project requires the following dependencies: ### 🔷 Installation -Build buenavista from the source and intsall dependencies: +Build buenavista from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-PydanticAI.md b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-PydanticAI.md index 79ec2277..cc70ebdc 100644 --- a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-PydanticAI.md +++ b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-PydanticAI.md @@ -415,7 +415,7 @@ This project requires the following dependencies: ### ⟒ Installation -Build pydantic-ai from the source and intsall dependencies: +Build pydantic-ai from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Python.md b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Python.md index 9157ba9a..fc5aa124 100644 --- a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Python.md +++ b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Python.md @@ -970,7 +970,7 @@ This project requires the following dependencies: ### 🟤 Installation -Build readme-ai from the source and intsall dependencies: +Build readme-ai from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-RAG.md b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-RAG.md index 3eae3665..6bc2d748 100644 --- a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-RAG.md +++ b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-RAG.md @@ -250,7 +250,7 @@ This project requires the following dependencies: ### 🌀 Installation -Build thepipe from the source and intsall dependencies: +Build thepipe from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Streamlit.md b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Streamlit.md index 6eac2098..6a769e4a 100644 --- a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Streamlit.md +++ b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Streamlit.md @@ -258,7 +258,7 @@ This project requires the following dependencies: ### 🟨 Installation -Build readme-ai-streamlit from the source and intsall dependencies: +Build readme-ai-streamlit from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Typescript.md b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Typescript.md index b036c4db..15dcf622 100644 --- a/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Typescript.md +++ b/docs/docs/examples/models/openai/gpt-3.5-turbo/README-Typescript.md @@ -119,7 +119,7 @@ This project empowers developers to build interactive chat applications seamless ├── package.json ├── screens │ ├── HomeScreen.tsx - │ └── Infomation.tsx + │ └── Information.tsx ├── server │ ├── .gitignore │ ├── config.js @@ -281,7 +281,7 @@ This project empowers developers to build interactive chat applications seamless - Infomation.tsx + Information.tsx - Define the Information screen layout and styling for the React Native app
- The screen presents the text Information within a centered container
- This component plays a key role in rendering essential information to users. @@ -378,7 +378,7 @@ This project requires the following dependencies: ### ⚫ Installation -Build ChatGPT-App-React-Native-TypeScript from the source and intsall dependencies: +Build ChatGPT-App-React-Native-TypeScript from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/platforms/bitbucket/README-Bitbucket.md b/docs/docs/examples/platforms/bitbucket/README-Bitbucket.md index ca38dcc2..6bf9d107 100644 --- a/docs/docs/examples/platforms/bitbucket/README-Bitbucket.md +++ b/docs/docs/examples/platforms/bitbucket/README-Bitbucket.md @@ -449,7 +449,7 @@ This project requires the following dependencies: ### ⚫ Installation -Build tictac-ai from the source and intsall dependencies: +Build tictac-ai from the source and install dependencies: 1. **Clone the repository:** diff --git a/docs/docs/examples/platforms/gitlab/README-GitLab.md b/docs/docs/examples/platforms/gitlab/README-GitLab.md index 724a9ed7..c204b9d6 100644 --- a/docs/docs/examples/platforms/gitlab/README-GitLab.md +++ b/docs/docs/examples/platforms/gitlab/README-GitLab.md @@ -305,7 +305,7 @@ This project requires the following dependencies: ### 🌾 Installation -Build badgie from the source and intsall dependencies: +Build badgie from the source and install dependencies: 1. **Clone the repository:** diff --git a/examples/readme-mlops.md b/examples/readme-mlops.md index 28aacda9..6b450039 100644 --- a/examples/readme-mlops.md +++ b/examples/readme-mlops.md @@ -137,7 +137,7 @@ The mlops-course project automates model training and hyperparameter tuning for | File | Summary | | --- | --- | | [cluster_env.yaml](https://github.com/GokuMohandas/mlops-course/blob/master/deploy/cluster_env.yaml) | Configure cluster computing environment for Ray with post-build Python package installations. | -| [cluster_compute.yaml](https://github.com/GokuMohandas/mlops-course/blob/master/deploy/cluster_compute.yaml) | Manages cloud resources for madewithml deployment in us-east2, specifying head and worker node types with their configurations.Intialized BlockDeviceMappings and TagSpecifications. | +| [cluster_compute.yaml](https://github.com/GokuMohandas/mlops-course/blob/master/deploy/cluster_compute.yaml) | Manages cloud resources for madewithml deployment in us-east2, specifying head and worker node types with their configurations.Initialized BlockDeviceMappings and TagSpecifications. | diff --git a/examples/readme-ollama.md b/examples/readme-ollama.md index f575b999..297cb253 100644 --- a/examples/readme-ollama.md +++ b/examples/readme-ollama.md @@ -147,7 +147,7 @@ | --- | --- | | [coverage.yml](https://github.com/eli64s/readme-ai/blob/master/.github/workflows/coverage.yml) | The.github/workflows/coverage.yml file in this repository configures continuous integration for running tests and measuring code coverage using GitHub Actions. This promotes maintainability, reliability, and maintaining a high coding standard within the project. | | [release-pipeline.yml](https://github.com/eli64s/readme-ai/blob/master/.github/workflows/release-pipeline.yml) | The `release-pipeline.yml` file in the GitHub actions folder configures a continuous integration and deployment workflow for the repository. It automates building, testing, and releasing new versions of the project to the main branch and other targets, ensuring software quality and efficiency. | -| [release-drafter.yml](https://github.com/eli64s/readme-ai/blob/master/.github/workflows/release-drafter.yml) | The `release-drafter.yml` file in the repositorys.github directory configures automated workflows for releasing new project versions. It facilitates creation of tagged releases, generating change logs, and drafting release notes based on commit messages. | +| [release-drafter.yml](https://github.com/eli64s/readme-ai/blob/master/.github/workflows/release-drafter.yml) | The `release-drafter.yml` file in the repositories.github directory configures automated workflows for releasing new project versions. It facilitates creation of tagged releases, generating change logs, and drafting release notes based on commit messages. | @@ -309,7 +309,7 @@ | File | Summary | | --- | --- | -| [tree.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/generators/tree.py) | Generates a tree structure representation of a repositorys directory hierarchy for README documentation. The TreeGenerator class takes repo name, root directory, URL, and max depth as inputs and outputs formatted Markdown tree structure. (60 tokens) | +| [tree.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/generators/tree.py) | Generates a tree structure representation of a repositories directory hierarchy for README documentation. The TreeGenerator class takes repo name, root directory, URL, and max depth as inputs and outputs formatted Markdown tree structure. (60 tokens) | | [builder.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/generators/builder.py) | The `readmeai/generators/builder.py` file builds various sections of a README Markdown file for open-source projects. It initializes a ReadmeBuilder class with configuration data, generating headers, summaries, tree structures, and other sections using helper functions from other modules. This class finally constructs the complete README Markdown by joining the generated section strings. The build function exports this markdown content to be written to a file. | | [utils.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/generators/utils.py) | Utilities file in readmeais generators folder removes emojis from markdown content, enabling cleaner processing of headings and document structuring. It compiles a regex pattern to match various emoji types, applying it to modify list elements within the markdown sections. | | [badges.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/generators/badges.py) | This Python file, located in readmeai/generators/badges.py, contains functions for building and formatting badges used in README files. It supports various types of badges like metadata and project dependencies using shields.io or skill icons from the skill-icons repository. The formatted badges can be aligned as per the config settings. | diff --git a/examples/readme-python-v0.5.87.md b/examples/readme-python-v0.5.87.md index cf636489..760ef184 100644 --- a/examples/readme-python-v0.5.87.md +++ b/examples/readme-python-v0.5.87.md @@ -5,7 +5,7 @@

README-AI

- Automated README documenation generator! + Automated README documentation generator!

license @@ -172,7 +172,7 @@ The `readme-ai` project is an automated README generator leveraging AI to synthe | File | Summary | | --- | --- | -| [ansible.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/configuration/ansible.py) | Parse Ansible configuration files for repositorys AI project. | +| [ansible.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/configuration/ansible.py) | Parse Ansible configuration files for repositories AI project. | | [properties.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/configuration/properties.py) | Parser for.properties configuration files extracting connection strings and package names. | | [apache.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/configuration/apache.py) | Parser for Apache configuration files in the `readme-ai` repository. | | [docker.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/configuration/docker.py) | Parser for Docker configuration files extracting package names from Dockerfile and services from docker-compose.yaml. | @@ -226,7 +226,7 @@ The `readme-ai` project is an automated README generator leveraging AI to synthe | File | Summary | | --- | --- | -| [composer.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/package/composer.py) | Parse PHP Composer configuration files for repositorys architecture. | +| [composer.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/package/composer.py) | Parse PHP Composer configuration files for repositories architecture. | | [npm.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/package/npm.py) | Parse npm and yarn.lock files to extract dependencies for documentation generation. | | [gradle.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/package/gradle.py) | Parser for extracting package names from Gradle dependency files. | | [nuget.py](https://github.com/eli64s/readme-ai/blob/master/readmeai/parsers/package/nuget.py) | Parser for NuGet.Config files in.NET, located in readmeai/parsers/package/nuget.py. | diff --git a/examples/readme-readmeai.md b/examples/readme-readmeai.md index 935f8fc5..58cdfc3c 100644 --- a/examples/readme-readmeai.md +++ b/examples/readme-readmeai.md @@ -126,7 +126,7 @@ README-AI is an innovative open-source project that leverages AI models to autom | [Dockerfile](https://github.com/eli64s/readme-ai/blob/main/Dockerfile) | Builds a Docker image for the readmeai package, setting up a non-root user, installing dependencies, and configuring the environment. The image runs the readmeai CLI by default. | | [Makefile](https://github.com/eli64s/readme-ai/blob/main/Makefile) | Manages repository cleanup, formatting, linting, and testing tasks.-Builds Conda package, generates requirements file, and searches for a word in the directory.-Executes various commands for maintaining code quality and project organization. | | [pyproject.toml](https://github.com/eli64s/readme-ai/blob/main/pyproject.toml) | Generates README files using AI models. Key features include markdown generation, badge integration, and AI-powered content creation. Supports Python, markdown, and various AI libraries. | -| [noxfile.py](https://github.com/eli64s/readme-ai/blob/main/noxfile.py) | Executes tests across multiple Python versions by installing the package and running the test suite with coverage reports. The code ensures seamless testing workflow for the repositorys Python versions. | +| [noxfile.py](https://github.com/eli64s/readme-ai/blob/main/noxfile.py) | Executes tests across multiple Python versions by installing the package and running the test suite with coverage reports. The code ensures seamless testing workflow for the repositories Python versions. | @@ -144,7 +144,7 @@ README-AI is an innovative open-source project that leverages AI models to autom | File | Summary | | --- | --- | -| [parsers](https://github.com/eli64s/readme-ai/blob/main/tests/parsers) | Validates data parsing functionality ensuring accurate extraction and transformation. Enhances data integrity and reliability within the repositorys architecture. | +| [parsers](https://github.com/eli64s/readme-ai/blob/main/tests/parsers) | Validates data parsing functionality ensuring accurate extraction and transformation. Enhances data integrity and reliability within the repositories architecture. | @@ -213,7 +213,7 @@ README-AI is an innovative open-source project that leverages AI models to autom | [cpp.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/cpp.py) | CMakeParser for CMakeLists.txt, ConfigureAcParser for configure.ac, and MakefileAmParser for Makefile.am. Each parser handles specific file types to identify dependencies, libs, and software. | | [swift.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/swift.py) | Extracts Swift package names from Package.swift files by parsing dependencies. | | [python.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/python.py) | Parses Python dependency files to extract package names without version specifiers.-Handles requirements.txt, TOML (Pipenv, Poetry, Flit), and YAML (environment.yml) formats.-Ensures robust error handling for parsing exceptions. | -| [go.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/go.py) | Extracts Go package dependencies from go.mod files using regex pattern matching. Inherits from BaseFileParser to parse content and handle parsing errors. Contributes to the repositorys parsers module for language-specific file parsing. | +| [go.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/go.py) | Extracts Go package dependencies from go.mod files using regex pattern matching. Inherits from BaseFileParser to parse content and handle parsing errors. Contributes to the repositories parsers module for language-specific file parsing. | | [rust.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/language/rust.py) | Extracts Rust package names from cargo.toml files using toml parsing library. | @@ -225,7 +225,7 @@ README-AI is an innovative open-source project that leverages AI models to autom | [bitbucket.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/bitbucket.py) | Extracts Bitbucket Pipelines configuration details for CI/CD workflows. | | [travis.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/travis.py) | Extracts CI/CD configurations from.travis.yml files. | | [gitlab.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/gitlab.py) | Extracts GitLab CI configuration details from.gitlab-ci.yml files. | -| [jenkins.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/jenkins.py) | Extracts Jenkinsfile configurations for CI/CD pipelines. Identifies and parses Jenkinsfile settings for automation and deployment processes within the repositorys architecture. | +| [jenkins.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/jenkins.py) | Extracts Jenkinsfile configurations for CI/CD pipelines. Identifies and parses Jenkinsfile settings for automation and deployment processes within the repositories architecture. | | [github.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/github.py) | Extracts GitHub Actions configurations for CI/CD pipelines from.github/workflows/ directory. | | [circleci.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/cicd/circleci.py) | Parses CircleCI configuration files in the readme-ai repository. | @@ -253,11 +253,11 @@ README-AI is an innovative open-source project that leverages AI models to autom | File | Summary | | --- | --- | | [composer.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/composer.py) | Extracts PHP Composer configuration details from composer.json files. | -| [npm.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/npm.py) | Extracts dependencies from package.json and yarn.lock files for the parent repositorys architecture. Parses JSON dependency files and yarn.lock files to retrieve package names for different sections. | +| [npm.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/npm.py) | Extracts dependencies from package.json and yarn.lock files for the parent repositories architecture. Parses JSON dependency files and yarn.lock files to retrieve package names for different sections. | | [gradle.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/gradle.py) | Parses Gradle dependency files to extract package names. Handles both build.gradle and build.gradle.kts formats, utilizing regex patterns for parsing. Implements error handling for parsing exceptions. | | [nuget.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/nuget.py) | Parses NuGet.Config files for.NET configuration settings. | | [yarn.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/yarn.py) | Extracts package names from a yarn.lock file using regex pattern matching. | -| [pip.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/pip.py) | Extracts and interprets Pip configuration files for the parent repositorys AI documentation tool. | +| [pip.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/pip.py) | Extracts and interprets Pip configuration files for the parent repositories AI documentation tool. | | [maven.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/maven.py) | Extracts Maven package names from pom.xml files, handling parsing errors. Parses groupId, artifactId, and version using regex. Appends spring if found in dependencies. Returns a set of unique dependencies. | | [gem.py](https://github.com/eli64s/readme-ai/blob/main/readmeai/parsers/package/gem.py) | Parses Gemfile.lock (Ruby) configuration files in the readme-ai repository. | diff --git a/examples/readme-sqlmesh.md b/examples/readme-sqlmesh.md index 493dc155..61c9481b 100644 --- a/examples/readme-sqlmesh.md +++ b/examples/readme-sqlmesh.md @@ -110,7 +110,7 @@ The sqlmesh-test-tools project is designed to enhance the reliability and effici | File | Summary | | --- | --- | | [sqlmesh_yml_generator.ipynb](https://github.com/eli64s/sqlmesh-test-tools/blob/main/notebooks/sqlmesh_yml_generator.ipynb) | Generates YAML configuration files for SQL unit tests by parsing SQL queries, executing them against a dataset, and outputting the results in a structured format to facilitate automated testing within the SQLMesh testing framework. This enhances the reliability of SQL data models by automating test validations. | -| [faker_dataset_generator.ipynb](https://github.com/eli64s/sqlmesh-test-tools/blob/main/notebooks/faker_dataset_generator.ipynb) | Generates synthetic datasets for testing SQL queries by leveraging the Faker library to produce realistic loan and restaurant service data, which are then saved as CSV files for integration into automated testing workflows within the repositorys SQL testing framework. | +| [faker_dataset_generator.ipynb](https://github.com/eli64s/sqlmesh-test-tools/blob/main/notebooks/faker_dataset_generator.ipynb) | Generates synthetic datasets for testing SQL queries by leveraging the Faker library to produce realistic loan and restaurant service data, which are then saved as CSV files for integration into automated testing workflows within the repositories SQL testing framework. | @@ -127,7 +127,7 @@ The sqlmesh-test-tools project is designed to enhance the reliability and effici | File | Summary | | --- | --- | -| [test_metric_loans_model.sql](https://github.com/eli64s/sqlmesh-test-tools/blob/main/sql/test_metric_loans_model.sql) | Analyzes loan data by computing metrics such as average loan amount, age demographics of applicants, and loan frequency within the year, integrating these insights through a series of joined SQL queries to facilitate comprehensive data-driven decision-making within the repositorys testing framework. | +| [test_metric_loans_model.sql](https://github.com/eli64s/sqlmesh-test-tools/blob/main/sql/test_metric_loans_model.sql) | Analyzes loan data by computing metrics such as average loan amount, age demographics of applicants, and loan frequency within the year, integrating these insights through a series of joined SQL queries to facilitate comprehensive data-driven decision-making within the repositories testing framework. | diff --git a/examples/readme-typescript.md b/examples/readme-typescript.md index 471c6a4f..2a05afc4 100644 --- a/examples/readme-typescript.md +++ b/examples/readme-typescript.md @@ -102,7 +102,7 @@ The ChatGPT-App-React-Native-TypeScript project is a mobile application built wi ├── package.json ├── screens │ ├── HomeScreen.tsx - │ └── Infomation.tsx + │ └── Information.tsx ├── server │ ├── .gitignore │ ├── config.js @@ -169,7 +169,7 @@ The ChatGPT-App-React-Native-TypeScript project is a mobile application built wi | File | Summary | | --- | --- | -| [Infomation.tsx](https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript/blob/master/screens/Infomation.tsx) | Displays an Infomation screen layout using React Native, presenting centered text within a container. | +| [Information.tsx](https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript/blob/master/screens/Information.tsx) | Displays an Information screen layout using React Native, presenting centered text within a container. | | [HomeScreen.tsx](https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript/blob/master/screens/HomeScreen.tsx) | Compose the HomeScreen component; integrates ListMessage and InputMessage within a Layout, key to the ChatGPT-App-React-Native-TypeScript architecture. | diff --git a/readmeai/config/settings.py b/readmeai/config/settings.py index 34222e47..7aae9365 100644 --- a/readmeai/config/settings.py +++ b/readmeai/config/settings.py @@ -338,7 +338,7 @@ def _load_settings(self) -> dict[str, dict]: config_dict = self.file_handler.read(file_path) settings[key] = config_dict setattr(self, key, config_dict) - _logger.info(f"Succesfully loaded cofing: {file_path.name}") + _logger.info(f"Successfully loaded cofing: {file_path.name}") themes_path = build_resource_path( file_path="emojis.yaml", submodule=f"{self.submodule}/themes" diff --git a/readmeai/config/settings/prompts.toml b/readmeai/config/settings/prompts.toml index b0146af4..19719a7a 100644 --- a/readmeai/config/settings/prompts.toml +++ b/readmeai/config/settings/prompts.toml @@ -30,9 +30,9 @@ SOURCE_CODE: {7} === INSTRUCTIONS === 1. **HTML:** Write the details using unordered HTML list elements. -2. **Syntax Highlighting:** When appropiate, use syntax highlighting, bold, and italics. DO NOT overuse. +2. **Syntax Highlighting:** When appropriate, use syntax highlighting, bold, and italics. DO NOT overuse. 4. **Specificity:** Provide concrete details, examples, and evidence from the codebase to support your analysis. -5. **Readability:** Ensure the table is well-structured, easy to read. Do not use ful sentences, only quick digestible points. +5. **Readability:** Ensure the table is well-structured, easy to read. Do not use full sentences, only quick digestible points. """ _file_summary = """ diff --git a/readmeai/config/settings/templates/quickstart.toml b/readmeai/config/settings/templates/quickstart.toml index d4ef0d90..25cb426b 100644 --- a/readmeai/config/settings/templates/quickstart.toml +++ b/readmeai/config/settings/templates/quickstart.toml @@ -16,7 +16,7 @@ $system_requirements installation = """### Installation -Build $repo_name from the source and intsall dependencies: +Build $repo_name from the source and install dependencies: $install_steps""" diff --git a/readmeai/core/pipeline.py b/readmeai/core/pipeline.py index f715a110..fbd16710 100644 --- a/readmeai/core/pipeline.py +++ b/readmeai/core/pipeline.py @@ -36,7 +36,7 @@ def error_handler() -> Generator[None, None, None]: def readme_agent(config: ConfigLoader, output_file: str) -> None: - """Wrap asyncronous README generation process with context manager.""" + """Wrap asynchronous README generation process with context manager.""" with error_handler(): asyncio.run(readme_generator(config, output_file)) diff --git a/readmeai/retrievers/git/providers.py b/readmeai/retrievers/git/providers.py index 1e399856..f4b8b500 100644 --- a/readmeai/retrievers/git/providers.py +++ b/readmeai/retrievers/git/providers.py @@ -124,7 +124,7 @@ def parse_git_url(url: Union[str, Path]) -> tuple[str, str, str, str]: if parsed_url.scheme not in ["http", "https"]: raise GitURLError( url, - f"Uknown scheme provided: {parsed_url.scheme}", + f"Unknown scheme provided: {parsed_url.scheme}", ) except ValueError as e: raise GitURLError(url) from e