jambor.pro/docs-onboarding
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update: Add better command to document git repo structure with git ls-tree.

Browse source
This commit is contained in:
Jan Jambor 2024-10-30 22:02:36 +01:00
parent 81b44d8b3d
commit 8958969e0e
1 changed files with 14 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

20
documentation-guidelines.md
View file

@ -37,15 +37,23 @@ drawio -x -f png -b 10 -o <output>.png <file>.drawio
If you want to add an optional folder structure to your documentation, you can use the following command to generate a tree-like structure. If you want to add an optional folder structure to your documentation, you can use the following command to generate a tree-like structure.
```bash ```bash
find . -type d ! -path '*/.*' | sed -e "s/[^-][^\/]*\// |/g" -e "s/|\([^ ]\)/|-\1/" git ls-tree -r --name-only HEAD | sed 's|[^/]*| &|g'
``` ```
Example output: Example output:
```text ```text
|-resources Dockerfile
| |-images maus_helper.sh
| |-diagrams maus_loader.yml
| |-scripts requirements.txt
|-know-how setup.py
src/ __init__.py
src/ logging_config/ __init__.py
src/ logging_config/ config.py
src/ maus_loader.py
src/ scraper/ __init__.py
src/ scraper/ scraper.py
tests/ __init__.py
tests/ test_scraper.py
``` ```