Skip to content

docs: add TOC to readme (fixes #333)#622

Merged
sas-grtoma merged 1 commit intomainfrom
IAC-1290
Apr 11, 2025
Merged

docs: add TOC to readme (fixes #333)#622
sas-grtoma merged 1 commit intomainfrom
IAC-1290

Conversation

@sas-grtoma
Copy link
Contributor

No description provided.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 11, 2025
fix

Signed-off-by: Griffin Tomaszewski <griffin.tomaszewski@sas.com>
@saschjmil saschjmil linked an issue Apr 11, 2025 that may be closed by this pull request
Copy link
Contributor

@saschjmil saschjmil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@iadomi
Copy link
Contributor

iadomi commented Apr 11, 2025

Are we only adding TOC for the main readme? I'm guessing the other .md either don't need it or already have one?

@sas-grtoma sas-grtoma merged commit 38954ab into main Apr 11, 2025
5 checks passed
@sas-grtoma
Copy link
Contributor Author

@iadomi Not sure - we could always go back and add it to more .md files. Do you think we should?

@saschjmil saschjmil deleted the IAC-1290 branch April 11, 2025 19:41
@iadomi
Copy link
Contributor

iadomi commented Apr 11, 2025

@iadomi Not sure - we could always go back and add it to more .md files. Do you think we should?

I think we're okay for now. The original ask from it #333 seem to suggest it was only a problem for the main readme and not the .md's in the docs folder. Quickly looking over some of the other .md's, they are much short in length

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: (IAC-1290) add a ToC in the main README file

4 participants