Skip to content

Commit

Permalink
docs/concept: page-level additions to section TOC
Browse files Browse the repository at this point in the history
This changes some pages' visibility inside the concept guide section's
TOC. This is done to work better with a parallel CL's addition of a
specific FAQ (symlinks) which makes sense to expose via the left-hand
nav TOC.

/docs/concept/faq/:
- include in parent section's left-hand nav TOC, placed at the bottom.
- include some on-page text introducing the list of FAQs, as the FAQ
  index will now be reachable from the left-hand nav.
- remove "(With Answers)" from section title, as it muddies this section
  and the parent section's left-hand nav TOCs.

/docs/concept/faq/*/:
- include in FAQ's section's left-hand nav TOC.

/docs/concept/modules/:
- add a weight to fix the page's position near the top of the parent
  section's left-hand nav TOC.

Preview-Path: /docs/concept/
Preview-Path: /docs/concept/faq/
Change-Id: I67d11ce37d3065ed3b024ed6342ff1f455887155
Signed-off-by: Jonathan Matthews <[email protected]>
Dispatch-Trailer: {"type":"trybot","CL":1204253,"patchset":8,"ref":"refs/changes/53/1204253/8","targetBranch":"master"}
  • Loading branch information
jpluscplusm authored and cueckoo committed Dec 5, 2024
1 parent fc84287 commit ab7e9e2
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 8 deletions.
8 changes: 6 additions & 2 deletions content/docs/concept/faq/_en.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: Frequently Asked Questions (With Answers)
toc_hide: true
title: Frequently Asked Questions
toc_hide: false
weight: 999
---

CUE's FAQs collect common questions about specific topics together on a single
page, along with their answers.

The following FAQs are available:
2 changes: 1 addition & 1 deletion content/docs/concept/faq/new-modules-vs-old-modules/en.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: New modules vs old modules
toc_hide: true
tags: [modules]
toc_hide: false
---

The [v0.9.0](/releases/v0.9.0) release of CUE
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Removing list arithmetic operators in CUE 0.11
authors: [jpluscplusm]
tags: [language]
toc_hide: true
toc_hide: false
---

{{{with _script_ "en" "HIDDEN: set up access to CUE v0.11 before release"}}}
Expand Down
1 change: 1 addition & 0 deletions content/docs/concept/modules/_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Modules
tags: [modules]
toc_hide: false
weight: 30
---

Modules are how CUE manages native dependencies.
Expand Down
1 change: 1 addition & 0 deletions content/docs/concept/the-logic-of-cue/en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "The Logic of CUE"
description: "Learn about CUE's theoretical basis and what makes it different."
weight: 20
toc_hide: false
math: true
aliases:
- /docs/concepts/logic
Expand Down
8 changes: 6 additions & 2 deletions hugo/content/en/docs/concept/faq/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: Frequently Asked Questions (With Answers)
toc_hide: true
title: Frequently Asked Questions
toc_hide: false
weight: 999
---

CUE's FAQs collect common questions about specific topics together on a single
page, along with their answers.

The following FAQs are available:
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: New modules vs old modules
toc_hide: true
tags: [modules]
toc_hide: false
---

The [v0.9.0](/releases/v0.9.0) release of CUE
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Removing list arithmetic operators in CUE 0.11
authors: [jpluscplusm]
tags: [language]
toc_hide: true
toc_hide: false
---

This guide answers some questions about a language change that happened in CUE
Expand Down
1 change: 1 addition & 0 deletions hugo/content/en/docs/concept/modules/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Modules
tags: [modules]
toc_hide: false
weight: 30
---

Modules are how CUE manages native dependencies.
Expand Down
1 change: 1 addition & 0 deletions hugo/content/en/docs/concept/the-logic-of-cue/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "The Logic of CUE"
description: "Learn about CUE's theoretical basis and what makes it different."
weight: 20
toc_hide: false
math: true
aliases:
- /docs/concepts/logic
Expand Down

0 comments on commit ab7e9e2

Please sign in to comment.