search

LDAR-Sim / LDAR_Sim

MIT License
11 stars 22 forks source link

[FEAT] Better Documentation - Centralized Readme #67

Open SEAJang opened 1 year ago

SEAJang commented 1 year ago

Requested Feature/Enhancement

Create a single README file that contains links to all other available README documents in the repository.

Need for feature/Enhancement

There are multiple different readme files, and it can be difficult to navigate to the proper readme document.

Problem to solve

Provide a way for individuals to gain easy access to all relevant documents in the repository.

Implementation Ideas

Create an additional MD file or edit the existing main README to have an additional section for navigation.

Additional context

N/A

ThomasGalesloot commented 4 months ago

@SEAJang Is this still something we want to do post V4 release?

SEAJang commented 4 months ago

@SEAJang Is this still something we want to do post V4 release?

I think this could still be useful, if time permits.