p4c icon indicating copy to clipboard operation
p4c copied to clipboard

Docs: Minor Link Fixes

Open AdarshRawat1 opened this issue 1 year ago • 4 comments

For better Presentation of content in generated documentation.

todo

  • [ ] Find a way to fix relative linking to subsections in Doxygen output for -
  • "guidelines" link https://p4lang.github.io/p4c/CodingStandardPhilosophy.md#Git-commits-and-pull-requests
  • "guidelines" link https://p4lang.github.io/p4c/CodingStandardPhilosophy.md#Handling-errors\
  • See also unsupported P4_16 language features.

AdarshRawat1 avatar Jul 10 '24 06:07 AdarshRawat1

Is this ready for review?

fruffy avatar Jul 12 '24 22:07 fruffy

Is this ready for review?

Filtering the repo to find more, to avoid extra PRs.

AdarshRawat1 avatar Jul 13 '24 11:07 AdarshRawat1

So the primary way that I know to review fixes for broken links is to wait until a PR like this is merged in, wait a little while until the doxygen task runs to generate new output from the changes, and then look at those.

I do not mind learning how to take a PR and locally, on my own development system, run doxygen on the changes and look at them on my local system. Are there step-by-step instructions for doing that somewhere?

jafingerhut avatar Jul 15 '24 13:07 jafingerhut

This newly created issue summarizes my confusion with how to use doxygen on p4c: https://github.com/p4lang/p4c/issues/4805

jafingerhut avatar Jul 15 '24 14:07 jafingerhut

So the primary way that I know to review fixes for broken links is to wait until a PR like this is merged in, wait a little while until the doxygen task runs to generate new output from the changes, and then look at those.

I do not mind learning how to take a PR and locally, on my own development system, run doxygen on the changes and look at them on my local system. Are there step-by-step instructions for doing that somewhere?

Yes, you can test the PR locally by checking out this PR.

  • Fetch the PR by using git fetch upstream pull/PR_ID/head Example for this PR-
git fetch upstream pull/4793/head   
  • Check out
git checkout FETCH_HEAD

AdarshRawat1 avatar Jul 19 '24 11:07 AdarshRawat1

Given that these changes are fairly small and focused, and that it is easier to see what is fixed in the docs once the changes are merged in (yes, I know I can try out the changes locally on my system from the PR, without it being merged in), I would like to see this merged in, so we can look for issues in the generated docs after these changes are merged.

If we end up with one or two extra PRs, I do not think that is a big issue, relative to knowing what we have generated from the latest main branch version of all files.

jafingerhut avatar Jul 21 '24 15:07 jafingerhut