Skip to content

Commit 59bf373

Browse files
committed
Update of README.md file with new feature of grouping issues by topics.
1 parent 311c189 commit 59bf373

File tree

1 file changed

+52
-10
lines changed

1 file changed

+52
-10
lines changed

README.md

Lines changed: 52 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
- [Data Mining from GitHub Projects](#data-mining-from-github-projects)
2828
- [Living Documentation Page Generation](#living-documentation-page-generation)
2929
- [Structured Output](#structured-output)
30+
- [Grouped Output by Issue Topics](#grouped-output-by-issue-topics)
3031
- [Contribution Guidelines](#contribution-guidelines)
3132
- [License Information](#license-information)
3233
- [Contact or Support Information](#contact-or-support-information)
@@ -114,12 +115,15 @@ See the full example of action step definition (in example are used non-default
114115

115116
# project state mining feature de/activation
116117
project-state-mining: true
117-
118-
# project verbose (debug) logging feature de/activation
119-
verbose-logging: true
120118

121119
# structured output feature de/activation
122120
structured-output: true
121+
122+
# group output by topics feature de/activation
123+
group-output-by-topics: true
124+
125+
# project verbose (debug) logging feature de/activation
126+
verbose-logging: true
123127
```
124128
125129
## Action Configuration
@@ -214,22 +218,31 @@ Configure the action by customizing the following parameters based on your needs
214218
project-state-mining: true
215219
```
216220

217-
- **verbose-logging** (optional, `default: false`)
218-
- **Description**: Enables or disables verbose (debug) logging.
221+
- **structured-output** (optional, `default: false`)
222+
- **Description**: Enables or disables structured output.
219223
- **Usage**: Set to true to activate.
220224
- **Example**:
221225
```yaml
222226
with:
223-
verbose-logging: true
227+
structured-output: true
224228
```
225-
226-
- **structured-output** (optional, `default: false`)
227-
- **Description**: Enables or disables structured output.
229+
230+
- **group-output-by-topics** (optional, `default: false`)
231+
- **Description**: Enable or disable grouping tickets by topics in the summary index.md file.
228232
- **Usage**: Set to true to activate.
229233
- **Example**:
230234
```yaml
231235
with:
232-
structured-output: true
236+
group-output-by-topics: true
237+
```
238+
239+
- **verbose-logging** (optional, `default: false`)
240+
- **Description**: Enables or disables verbose (debug) logging.
241+
- **Usage**: Set to true to activate.
242+
- **Example**:
243+
```yaml
244+
with:
245+
verbose-logging: true
233246
```
234247

235248
## Action Outputs
@@ -394,6 +407,8 @@ export INPUT_REPOSITORIES='[
394407
]'
395408
export INPUT_OUTPUT_PATH="/output/directory/path
396409
export INPUT_PROJECT_STATE_MINING="true"
410+
export INPUT_STRUCTURED_OUTPUT="true"
411+
export INPUT_GROUP_OUTPUT_BY_TOPICS="true"
397412
export INPUT_VERBOSE_LOGGING="true"
398413
```
399414
@@ -601,13 +616,40 @@ This feature allows you to generate structured output for the living documentati
601616
|-- issue md page 1
602617
|-- issue md page 2
603618
|-- _index.md
619+
|-- _index.md
604620
|- org 2
605621
|--repo 1
606622
|-- issue md page 1
607623
|-- _index.md
608624
|--repo 2
625+
...
626+
|-- _index.md
627+
|- _index.md
628+
```
629+
630+
### Grouped Output by Issue Topics
631+
632+
The feature allows you to generate output grouped by issue topics. This feature is useful when you want to group issues by specific topics or themes.
633+
634+
To gain a better understanding of the term "Topic", refer to the [Labels](#labels) section.
635+
636+
- **Default Behavior**: By default, the action generates all the documentation in a single directory.
637+
- **Non-default Example**: Use the grouped output feature to organize the generated documentation by issue topics.
638+
- `group-output-by-topics: true` activates the grouped output feature.
609639
```
640+
output
641+
|- topic 1
642+
|-- issue md page 1
643+
|-- issue md page 2
644+
|-- _index.md
645+
|- topic 2
646+
|-- issue md page 1
647+
|-- _index.md
648+
|- _index.md
649+
```
650+
610651
---
652+
611653
## Contribution Guidelines
612654

613655
We welcome contributions to the Living Documentation Generator! Whether you're fixing bugs, improving documentation, or proposing new features, your help is appreciated.

0 commit comments

Comments
 (0)