Git Quickstart guide link broken

[WickedStereo]

Description

The link to the Git Quickstart guide in the file docs/contrib/DeveloperGuide.md is broken and returns a 404 Not Found error.

Steps to Reproduce

1. Navigate to docs/contrib/DeveloperGuide.md in the repository.
2. Click on the link to the Git Quickstart guide (last point in the file)

Suggested Solution

Update the link to a valid Git Quickstart guide.

Additional Context

No response

[luarss]

Hi, please refer to this link for the timebeing https://openroad-flow-scripts.readthedocs.io/en/latest/contrib/GitGuide.html

The actual file does not exist in the repo because we share the same Git Quickstart guide with OR repo.

[WickedStereo]

Thanks for letting me know. Do you want me to add the doc from OR to the ORFS repo or else, change the doc link to the OR repo doc and submit a pull request?

[maliberty]

I don't want to have two copies that can drift apart. Is there a way we can make the link work when viewed from GH?

[WickedStereo]

That's right! A simple solution is to use the absolute URL to the file from OR. The only issue is that it would always point to github and not work locally.
I checked other possible solutions which include creating submodules or automation using github actions.

[luarss]

Thats not the only thing that needs to change.

https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/docs/conf.py

In our setup we download the markdown, do regex swap for OR into ORFS then render it.