Here is a summary of the changes made for this PR:
Created a Bash Script: Created a Bash script named add_titles_to_md_files.sh. This script is designed to read all the .md files in the ./docs/Technical-docs/interfaces and ./docs/Technical-docs/modules directories and extract the third line from each file (which was the desired title in this case) and insert it at the top of the respective file enclosed within a YAML frontmatter block. This ensures that all the markdown files have appropriate titles for GitBook to parse.
Added postdoc Script: A new npm script called postdoc was added to the package.json file. This script automatically executes the add_titles_to_md_files.sh script each time the documentation script is run. This ensures that our markdown files always have the correct titles whenever the documentation is generated or updated.
Updated GitBook Configuration: The .gitbook.yaml file was updated to ensure that the documentation structure aligns with the GitBook expectations. The Tutorial section wasn't displaying in GitBook because it wasn't included in the GitBook structure. So, I removed the summary field from the .gitbook.yaml file and cfrom the ./docs as well. An additional markdown file named how-to-start.md inside the ./docs/Tutorial was added.
With these changes, all markdown files should now have the correct titles, and the GitBook documentation should reflect the entire structure of the project, including the previously missing Tutorial section.
Here is a summary of the changes made for this PR:
Created a Bash Script: Created a Bash script named add_titles_to_md_files.sh. This script is designed to read all the .md files in the
./docs/Technical-docs/interfacesand./docs/Technical-docs/modulesdirectories and extract the third line from each file (which was the desired title in this case) and insert it at the top of the respective file enclosed within a YAML frontmatter block. This ensures that all the markdown files have appropriate titles for GitBook to parse.Added postdoc Script: A new npm script called
postdocwas added to the package.json file. This script automatically executes the add_titles_to_md_files.sh script each time the documentation script is run. This ensures that our markdown files always have the correct titles whenever the documentation is generated or updated.Updated GitBook Configuration: The .gitbook.yaml file was updated to ensure that the documentation structure aligns with the GitBook expectations. The Tutorial section wasn't displaying in GitBook because it wasn't included in the GitBook structure. So, I removed the summary field from the .gitbook.yaml file and cfrom the
./docsas well. An additional markdown file named how-to-start.md inside the ./docs/Tutorial was added.With these changes, all markdown files should now have the correct titles, and the GitBook documentation should reflect the entire structure of the project, including the previously missing Tutorial section.