Add back in heading for P4Smith README file #4756
Conversation
|
This will break the formatting of the README itself:
|
|
Looks like the formatting is similarly broken in other places: https://github.com/jafingerhut/p4c/tree/add-readme-heading-for-better-doxygen-index/backends/p4tools/modules/testgen |
|
I am open to anything that you find acceptable for the page itself, but it seems very poor to have the Doxygen index of articles include "README" for this file. @AdarshRawat1 Any Doxygen configuration tricks you know of that might help here? |
Issue hereThe page name and title come from the file name or level one heading, and Standard Markdown does not support header labeling. If we can remove the image, then this should sort the issue of header name. |
|
@fruffy What do you think of Adarsh's idea of removing the P4 logo image, and the second heading, but keeping the new first one? The test-tools pass/fail badge would stay. |
Not happy since the logo adds some flavor but it can't be helped. The clean documentation takes priority. |
|
Ugh. Forgot to add DCO to these commits. Will try to add them retroactively. |
This makes the auto-generated doxygen index easier to distinguish this files from others, instead of merely being called "README" there. Signed-off-by: Andy Fingerhut <[email protected]>
Maybe not as nice of a visual look as what was there before, but seems worth looking at to see if it is desirable. Signed-off-by: Andy Fingerhut <[email protected]>
since previous attempt to keep it messed up the CI badge when viewing Github flavored Markdown on github.com Signed-off-by: Andy Fingerhut <[email protected]>
jafingerhut
force-pushed
the
add-readme-heading-for-better-doxygen-index
branch
from
c1b24d9
to
8d37a3f
Compare
|
DCO is still optional :) I agree it is quite annoying. |
|
The instructions for adding DCO retroactively works, even if you forgot them for multiple commits. Good! |
|
Could also do this for P4Testgen? |
Signed-off-by: Andy Fingerhut <[email protected]>
Done |
How about having P4 image on the right-hand side of the page like this ?? |
The thing was that the P4 logo + Testgen creates P4Testgen, which is now lost. |
* Add back in heading for P4Smith README file This makes the auto-generated doxygen index easier to distinguish this files from others, instead of merely being called "README" there. Signed-off-by: Andy Fingerhut <[email protected]> * Trying out a thing where the P4 logo is put before the CI badge Maybe not as nice of a visual look as what was there before, but seems worth looking at to see if it is desirable. Signed-off-by: Andy Fingerhut <[email protected]> * Removing logo since previous attempt to keep it messed up the CI badge when viewing Github flavored Markdown on github.com Signed-off-by: Andy Fingerhut <[email protected]> * Also remove extra heading for P4Testgen Signed-off-by: Andy Fingerhut <[email protected]> --------- Signed-off-by: Andy Fingerhut <[email protected]> Signed-off-by: Adarsh <[email protected]>
This makes the auto-generated doxygen index easier to distinguish this files from others, instead of merely being called "README" there.