Skip to content

Update User Guide on GitHub Pages Publishing #2467

@gekjunxu

Description

@gekjunxu

What problem(s) did you run into that caused you to request additional documentation? What, if any, existing documentation relates to this proposal?

When I tried to fork the publish-RepoSense to generate my own report, I was unable to see the published report by followng the User Guide alone. The User Guide does not explicitly specify that I had to select a branch for the GitHub Actions workflow to publish the page.

What would you like added or modified in the documentation?

I figured that the branch gh-pages needed to be selected for the report site to be published. Instructions for the user to select the branch, along with screenshot(s) may be helpful.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions