You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Enhance the Diplodoc CLI by introducing a feature that automatically generates a toc.yaml if it does not already exist. The feature should create a structured Table of Contents reflecting the files in a directory. It is essential that:
Each file should have properly formatted titles for clarity.
The ToC generation process should ignore folder names starting with an underscore _.
Proposed Solution:
Implement a feature with the following capabilities:
Check if a toc.yaml file already exists in the directory.
If no toc.yaml is present, try to auto-generate one by scanning the directory's files.
Extract and format titles for each file.
Exclude any directories that start with an underscore _.
Use Cases:
Automatically maintaining a ToC for projects without manual input.
Ensuring that documentation hierarchies reflect actual file structures, excluding non-essential folders.
Benefits:
Eases the process of setting up new documentation directories by automatically generating a toc.yaml.
Maintains clarity by organizing content without displaying non-user-facing directories.
The text was updated successfully, but these errors were encountered:
martyanovandrey
changed the title
Feature Request: Auto-Generate Table of Contents Based on Input Directory
Auto-Generate Table of Contents Based on Input Directory
Dec 11, 2024
Enhance the Diplodoc CLI by introducing a feature that automatically generates a toc.yaml if it does not already exist. The feature should create a structured Table of Contents reflecting the files in a directory. It is essential that:
_
.Proposed Solution:
Implement a feature with the following capabilities:
_
.Use Cases:
Benefits:
The text was updated successfully, but these errors were encountered: