Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to include --update-only flag #4801

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

Gyan-max
Copy link

  • Added titles to README.md, CONTRIBUTING.md, and CHECKERS.md to ensure proper linking in Sphinx documentation.
  • Corrected paths for sbom/sboms_for_humans/index and sbom/sboms_for_humans/README in index.rst.
  • Updated index.rst to include the new --update-only flag description.
  • Verified and rebuilt the documentation to resolve warnings related to missing titles and incorrect paths.

This commit ensures that the documentation is correctly generated with all necessary links and resolves the warnings encountered during the Sphinx build process.

Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

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

Looks like you accidentally checked in a whole _build/ directory that will need to be removed from this PR. You might want to add _build/ to .gitignore to avoid it happening again (or just remember that git add * is never your friend!)

@Gyan-max
Copy link
Author

Hi @terriko
Can you guide me on this. I am getting confused in which branch I pushed my code and I think I again made some mistakes while committing.
Please review my commits and guide me over this.

@Gyan-max Gyan-max requested a review from terriko February 16, 2025 19:58
Copy link
Contributor

@JigyasuRajput JigyasuRajput left a comment

Choose a reason for hiding this comment

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

Hey @Gyan-max! A quick fix would be to create a new branch and commit only the necessary changes. Also, when using "git add .", be careful—it adds all modified files, including the build ones.

@terriko
Copy link
Contributor

terriko commented Feb 20, 2025

You can actually check the branch at the top of the github web interface: it says it's Gyan-max:feature/update-only-flag

Given how many files there are you need to remove from this PR, you might actually find it easier to make a new branch and new pr and just be careful about what files are checked in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants