BIRDSOpenSource / BIRDSOpenSource/BIRDS3-SolarPanel

make detailed readme

Open
#1 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
No language data
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

create a visualisation of organisational structure of this repo similar to the one here

https://github.com/BIRDSOpenSource/BIRDS3-ProceduresAndReports

and add to the Organisation Structure section

my method is a bit long, maybe you can find an alternative

1. install trees in your cli
2. type the following command to print a list of the files in the repo gh api '/repos/BIRDSOpenSource/BIRDS3-COM/git/trees/main?recursive=true' -q '.tree[]|.path'
3. copy list into a blank txt file and save
4. use this python code to display the visualisation of the files

```
import os

# Read paths from a file
with open('b3prpaths.txt', 'r') as f:
paths = [line.strip() for line in f.readlines()]

# Sample list of paths (replace this with the output from your command)
# paths = [
# "src/main/java/com/example/App.java",
# "src/main/resources/config.yml",
# "src/test/java/com/example/AppTest.java",
# "docs/README.md",
# "docs/INSTALL.md"
# ]

def build_tree(paths):
tree = {}
for path in paths:
parts = path.split('/')
current = tree
for part in parts:
if part not in current:
current[part] = {}
current = current[part]
return tree

def print_tree(tree, prefix=''):
keys = sorted(tree.keys())
for index, key in enumerate(keys):
if index == len(keys) - 1:
print(prefix + '└── ' + key)
new_prefix = prefix + ' '
else:
print(prefix + '├── ' + key)
new_prefix = prefix + '│ '
print_tree(tree[key], new_prefix)

# Build the tree from paths
tree = build_tree(paths)

# Print the tree
print_tree(tree)
```

6. copy the results on the CLI and paste in the Organisational structure section (remove specific files, the tree should only show folder levels)

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the repository README and locate the Organisation Structure section. Review the linked BIRDS3-ProceduresAndReports example and the supplied GitHub API/Python method, then add a folder-only visual tree for this repository; the section should show directory levels without individual files.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.