Skip to content

fix typos #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix typos #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/examples/archive/readme-mlops.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

</details>

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/examples/archive/readme-ollama.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

</details>

Expand Down Expand Up @@ -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. |
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/examples/archive/readme-python-v0.5.87.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<h1 align="center">README-AI</h1>
</p>
<p align="center">
<em>Automated README documenation generator!</em>
<em>Automated README documentation generator!</em>
</p>
<p align="center">
<img src="https://img.shields.io/github/license/eli64s/readme-ai?style=flat&logo=opensourceinitiative&logoColor=white&color=0080ff" alt="license">
Expand Down Expand Up @@ -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. |
Expand Down Expand Up @@ -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. |
Expand Down
12 changes: 6 additions & 6 deletions docs/docs/examples/archive/readme-readmeai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

</details>

Expand All @@ -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. |

</details>

Expand Down Expand Up @@ -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. |

</details>
Expand All @@ -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. |

Expand Down Expand Up @@ -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. |

Expand Down
Loading