cue-lang / docs-and-content

A place to discuss, plan, and track documentation on cuelang.org
5 stars 1 forks source link

docs/tour: make ready for go-live #78

Closed jpluscplusm closed 6 months ago

jpluscplusm commented 7 months ago

The existing tour will be elevated temporarily whilst the Language Guide is hidden for go-live.

jpluscplusm commented 7 months ago
  • add any pages required to act as inbound link targets, where existing pages currently link to the LG

After a review of links to the language guide, and the tour's current set of pages, I conclude that these pages would need adding to the existing tour to meet the needs of the links that currently exist elsewhere on the site:

jpluscplusm commented 7 months ago
  • Fields: docs/language-guide/data/maps-and-fields
  • Optional field constraints: docs/language-guide/schemas-and-validation/field-constraints#optional-field-constraints
  • Required field constraints: docs/language-guide/schemas-and-validation/field-constraints#required-field-constraints
  • Regular fields: docs/language-guide/data/maps-and-fields#field-names

Covered by changes proposed in https://cuelang.org/cl/1177590

  • Value constraints: docs/language-guide/schemas-and-validation/value-constraints

Covered by changes proposed in https://cuelang.org/cl/1177605

  • Querying: language-guide/templating/comprehensions

Covered by changes proposed in https://cuelang.org/cl/1177561

jpluscplusm commented 7 months ago
  • add any pages required by the temporary removal of the LG

Let's add docs/tour/expressions/query-projection/, after https://alpha.cuelang.org/docs/tour/expressions/conditional/, that shows an example of:

jpluscplusm commented 7 months ago

Let's add docs/tour/expressions/query-projection/

Proposed in https://cuelang.org/cl/1177629

jpluscplusm commented 6 months ago
  • fix up the flow through the different sections

https://review.gerrithub.io/c/cue-lang/cuelang.org/+/1177973

jpluscplusm commented 6 months ago

@myitcv Before I start writing it, do you agree with my final (added later) bullet point; that the tour should include "a section demonstrating the CLI's core operations"?

jpluscplusm commented 6 months ago
  • add a front page for the tour

https://cuelang.org/cl/1178168

jpluscplusm commented 6 months ago

Closed via https://github.com/cue-lang/cuelang.org/commit/ff7f9290934b1cfb133709506d2a47a48ce7a5a7.