Skip to content

Commit

Permalink
docs: Remove Under the hood section
Browse files Browse the repository at this point in the history
  • Loading branch information
kvankova committed Nov 7, 2024
1 parent 178068a commit c97c22d
Showing 1 changed file with 0 additions and 7 deletions.
7 changes: 0 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,13 +215,6 @@ class Person:

With any changes to the function `print_hello` or class `Person` in `main.py`, the code block sections are updated in the `README` file with the next workflow run.


## πŸ”¬ Under the hood
This action performs the following steps:
1. πŸ”Ž Scans through the markdown (`README`) files to identify referenced script files (full script, section or 🐍 Python object).
1. πŸ“ Extracts the contents from those script files and updates the corresponding code blocks in the markdown (`README`) files.
1. πŸš€ Commits and pushes the updated documentation back to the repository.

## 🀝 Contributing
We welcome contributions to improve this tool!
- If you have an idea for a **new feature** ✨, open a [new feature request](https://github.com/kvankova/code-embedder/issues/new?labels=enhancement&template=feature_request.yaml) on GitHub.
Expand Down

0 comments on commit c97c22d

Please sign in to comment.