Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: present a short CUE example on /docs
This updates the opening of the /docs landing page and includes a very brief example of some CUE validating some data. The introductory prose is updated and made shorter, in order to place some CUE in front of the newcomer immediately - as soon as they reach the docs section. It uses (arguably) the shortest possible CUE example that directly and plainly communicates some of CUE's power and elegance - hopefully prompting the reader to continue clicking through the site. The leading prose is lifted directly from the the opening of the /docs/introduction page proposed in https://cuelang.org/cl/1195016: (a) because it fulfills the site's needs in both locations (summarising CUE succinctly, and leading naturally on to the short example), and (b) because we don't know which page a complete newcomer will land on, and this prose encapsulates the information we want such a user to internalise quickly, in both locations. The brevity of the example CUE is important, as we don't want to push the "How to use this documentation" section below the fold. The prose selected is optimised to achieve this in low resolution tests (1024x768 was targetted), so that the reader's eye might still be lead on to the explanatory cards at the end of the page. A sentence drawing the reader to the cards is added to that section's introduction. To increase the chances of the section being visible on smaller (desktop) screens, the per-page mechanism to prevent the minimum-version notification popup (introduced in https://cuelang.org/cl/1178371) is engaged on the /docs landing page. Preview-Path: /docs/ Signed-off-by: Jonathan Matthews <[email protected]> Change-Id: Ie9c20bd8feec9245bff40bc9a544b2f5bf147836 Reviewed-on: https://review.gerrithub.io/c/cue-lang/cuelang.org/+/1197437 TryBot-Result: CUEcueckoo <[email protected]> Reviewed-by: Paul Jolly <[email protected]>
- Loading branch information