Skip to content

Add documentation for new features #185

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

Merged
merged 6 commits into from
Apr 10, 2025

Conversation

Pennycook
Copy link
Contributor

Related issues

N/A

Proposed changes

  • Remove documentation of features that are no longer available in 2.0.0.
  • Add documentation for new command line interfaces (i.e., cbi-cov and cbi-tree).
  • Work cbi-tree into the tutorial in relevant places, to highlight that it exists.
  • Briefly mention custom compilers in the tutorial, with a link to more information for expert users.

As it says in the commit history, I'm reluctant to write a full-fledged tutorial for custom compiler behavior at this point. The tutorial we have right now is really a quickstart guide, and I'm hoping that most users won't have to define really complicated custom behaviors to get meaningful results. But I've added a note that people should file an issue if I'm wrong.

If it turns out that we need a better tutorial or more documentation for this feature, I think we can always do this after 2.0.0 releases. There's no reason that we can't update the documentation independently.

- Add --debug
- Remove -R files

Signed-off-by: John Pennycook <[email protected]>
Divergence is no longer the only metric calculated by CBI, and we can now
measure and visualize platform coverage.

Signed-off-by: John Pennycook <[email protected]>
For now, this is not a full tutorial. I would like to collect more feedback
from users about how often they encounter this functionality before spending
more time writing a complete tutorial for it.

Signed-off-by: John Pennycook <[email protected]>
@Pennycook Pennycook added the documentation Improvements or additions to documentation label Apr 8, 2025
@Pennycook Pennycook added this to the 2.0.0 milestone Apr 8, 2025
@Pennycook Pennycook requested a review from laserkelvin April 8, 2025 09:15
@Pennycook Pennycook merged commit adba0e7 into P3HPC:main Apr 10, 2025
2 checks passed
@Pennycook Pennycook deleted the doc/2.0.0-features branch April 10, 2025 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants