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

Various improvements to documentation #517

Merged
merged 19 commits into from
Nov 17, 2023
Merged

Various improvements to documentation #517

merged 19 commits into from
Nov 17, 2023

Conversation

arbimo
Copy link
Member

@arbimo 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-commenter
Copy link

codecov-commenter commented Nov 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (282488f) 85.08% compared to head (faf34e8) 85.08%.
Report is 16 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

@arbimo
Copy link
Member Author

arbimo commented Nov 9, 2023

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:

  • Add "Application Showcase" section (for use-case inspired guidelines), currently with space and drones use-cases.
  • Initial work on presenting the available engines in a table with high-level features
  • "Problem Representation" page should act as an overview of the various problem classes with pointers to detailed presentations (done for hierarchical and scheduling)
  • Added a "Contributor's guide" page, currently with explanation to build and update the documentation.
  • Added a "What is Planning" page
  • Integrated ICAPS tutorial material (currently some overlap with the Quickstart)

@Framba-Luca could you fill in the docs/engines/04_testing_engine.rst file with documentation on how to run the report tool and what is expected for a valid integration.

@mikand: The "Planning Engine Examples" (docs/notebooks/engines/README.md) page was needed for a deliverable right? It feel a bit strange where it currently is or could even be removed entirely.

@alvalentini Could you review the docs/showcases/01-space.md document and perhaps add an illustration.

@arbimo arbimo marked this pull request as ready for review November 9, 2023 17:01
Framba-Luca and others added 2 commits November 15, 2023 10:31
docs/conf.py Outdated Show resolved Hide resolved
docs/engines/01_available_engines.rst Outdated Show resolved Hide resolved
- Metrics
* - `Fast-Downward`_
- OneShot, Anytime
- 🗸
Copy link
Member

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?

Copy link
Member Author

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)

@alvalentini
Copy link
Member

@arbimo
The Planning Engines Example page is not needed in the ReadTheDocs documentation. We've included this link (https://github.com/aiplan4eu/unified-planning/tree/master/docs/notebooks/engines) in a deliverable and we only need to keep the file reachable through that link.

@arbimo
Copy link
Member Author

arbimo commented Nov 17, 2023

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.

@alvalentini alvalentini merged commit 73cacaa into master Nov 17, 2023
8 checks passed
@alvalentini alvalentini deleted the docs branch November 17, 2023 13:36
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.

4 participants