-
Notifications
You must be signed in to change notification settings - Fork 39
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
Various improvements to documentation #517
Conversation
arbimo
commented
Nov 8, 2023
- fix(doc): Fix broken link to compiler notebook.
- doc: Add contributor's guide
- fix(doc): Fix syntax error in markdown source (CONTRIBUTING.md)
- doc: Initial work on improved engine pages
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #517 +/- ##
=======================================
Coverage 85.08% 85.08%
=======================================
Files 200 200
Lines 26336 26336
=======================================
Hits 22407 22407
Misses 3929 3929 ☔ View full report in Codecov by Sentry. |
Co-authored-by: Gabi Roeger <gabriele.roeger@unibas.ch>
This PR refactors some parts of the documentation as a preparation for the final deliverable. It would be great to have it merged quickly so I can then ping other people to fill it more. Notable changes:
@Framba-Luca could you fill in the @mikand: The "Planning Engine Examples" ( @alvalentini Could you review the |
…ine.rst file with the instruction on how to use the report.py script
- Metrics | ||
* - `Fast-Downward`_ | ||
- OneShot, Anytime | ||
- 🗸 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I build the docs locally, this symbol is not rendered well. Am I missing any requirements?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Strange, it is just a UTF-8 character. Probably, a font problem. I'll change it to Y
for better compatibility (but it looks less cool)
@arbimo |
Thanks @alvalentini and @Framba-Luca I have made a few changes following your remarks and contributions. I think this is now ready. I will ping engine developers to validate and complete it once the documentation is easily visible. |