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

docs: restructure introduction #1151

Merged
merged 1 commit into from
Oct 22, 2024

Conversation

TomCools
Copy link
Contributor

@TomCools TomCools commented Oct 18, 2024

Solves: #1150

Brought the documentation more in line with the other documentation elements.

  • Shortened the introduction page
  • Introduced the same PlanningAI Concepts page as on other sites (minus the reference to the platform). This was originally also in the "introduction"
  • Introduced an FAQ to place information which people will look for (like the licensing). Good place to add additional things Sales get asked about often.

Also removed from the introduction page:

  • The list of different Use Cases. While that is somewhat valuable, i'd like to re-introduce those in the form of images. I left the current image which already shows 4 use-cases. Longer term, let's introduce an "Example Use Cases" heading to the documentation where we make these shine a bit more.
  • Note on Backwards Compatibility. I think this does not belong in an Intro. I have removed it for now as I think the expectation is always that this information should flow through the Changelog.
  • How to use Timefold Solver => Should be part of the quickstarts, so pushing people to the quickstarts sooner.

Copy link
Contributor

@lee-carlon lee-carlon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, @TomCools.

I've added a couple of very minor tweaks.

It might be a good idea to include @triceo as a reviewer.

@TomCools TomCools force-pushed the docs/1150-simply-introduction branch from c348267 to 43093e0 Compare October 21, 2024 06:14
@TomCools TomCools force-pushed the docs/1150-simply-introduction branch from 43093e0 to 7cdcba4 Compare October 21, 2024 06:15
Also fixed some links by moving the files.
@TomCools TomCools force-pushed the docs/1150-simply-introduction branch from 7cdcba4 to 19a3e6d Compare October 21, 2024 06:36
@TomCools TomCools requested a review from triceo October 21, 2024 06:37
@triceo triceo merged commit 6f5f54f into TimefoldAI:main Oct 22, 2024
1 check passed
@triceo triceo added this to the 1.16.0 milestone Oct 22, 2024
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.

3 participants