Skip to content

ORFS Git Guide should mention forking OR #2213

Closed

Description

@vvbandeira

Subject

[Documentation] for documentation errors.

Describe the bug

Our current submodule setup also requires the user to fork the OpenROAD repo for their fork of ORFS to be able to build.
We need to include this in the docs here and likely mention it in the main readme as well.

Expected Behavior

The command git clone --recursive <FORK_URL> should work on forks.

Environment

Does not apply.

To Reproduce

Fork ORFS.
Do not fork OR.
Clone ORFS and try to build.

Relevant log output

No response

Screenshots

No response

Additional Context

No response

Activity

  1. Krupakar-Reddy-S commented on Aug 3, 2024

    @Krupakar-Reddy-S

    i want to work on this

  2. maliberty commented on Aug 3, 2024

    @maliberty
    Member

    Thanks

  3. YadavAkhileshh commented on Feb 20, 2026

    @YadavAkhileshh

    Hi @maliberty, I see this issue is unassigned. I'm interested in GSoC 26 and would love to fix this. Can I work on it? I'll add forking instructions to the Git guide and README.

  4. shubhika123 commented on Mar 29, 2026

    @shubhika123

    Hello @maliberty , can I please be assigned this issue to work upon?

  5. github-actions commented on May 29, 2026

    @github-actions
    Contributor

    This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 21 days if no further activity occurs. Remove the Stale label or comment to keep it open.

  6. added
    StaleA stale PR or issue subject to automated closure.
    on May 29, 2026
  7. shubhika123 commented on May 29, 2026

    @shubhika123

    I was looking into this issue and noticed that PR #4070 was recently merged to address the documentation generation workflow that affected the previous fixes. Does #2213 still require any additional changes, or has the issue been fully resolved by #4070?

  8. removed
    StaleA stale PR or issue subject to automated closure.
    on May 30, 2026
  9. vvbandeira commented on Jun 4, 2026

    @vvbandeira
    MemberAuthor

    The issue has been fully resolved by #4070
    Thanks for your contribution regardless

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

Metadata

Metadata

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions