diff --git a/content/billing/concepts/product-billing/github-advanced-security.md b/content/billing/concepts/product-billing/github-advanced-security.md index f4e3f8752093..15a537177abe 100644 --- a/content/billing/concepts/product-billing/github-advanced-security.md +++ b/content/billing/concepts/product-billing/github-advanced-security.md @@ -96,10 +96,7 @@ There are two different ways to pay for licenses. * Purchase a specific number of {% data variables.product.prodname_GHAS_cs_or_sp %} licenses that last for a defined period, typically at least a year, see {% ifversion fpt or ghec %}[AUTOTITLE](/billing/how-tos/products/add-advanced-security){% elsif ghes %}[AUTOTITLE](/enterprise-cloud@latest/billing/how-tos/products/add-advanced-security) in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}. * If the usage of {% data variables.product.prodname_AS %} by active committers exceeds the number of licenses purchased, you need to purchase additional licenses to cover this overage usage. - - -{% ifversion fpt or ghec %}To view your current license usage, see [AUTOTITLE](/billing/managing-billing-for-your-products/viewing-your-product-usage).{% endif %} - +To view your current license usage, see [AUTOTITLE](/billing/managing-billing-for-your-products/viewing-your-product-usage). ### Understanding usage diff --git a/content/contributing/style-guide-and-content-model/style-guide.md b/content/contributing/style-guide-and-content-model/style-guide.md index 1cf23c5416c6..be2e0507d7f2 100644 --- a/content/contributing/style-guide-and-content-model/style-guide.md +++ b/content/contributing/style-guide-and-content-model/style-guide.md @@ -551,7 +551,7 @@ For presenting keyboard shortcuts, follow the [Microsoft Style Guide](https://do ### Usage highlights -Below are some usage highlights for how we present keyboard shortcuts in our documentation: +Here are some usage highlights for how we present keyboard shortcuts in our documentation: * The basic syntax is to show keys with `+` between key combinations, without any spaces. @@ -592,7 +592,7 @@ Below are some usage highlights for how we present keyboard shortcuts in our doc Do not create reusables for license attributions. We must use the exact license a project is licensed under, so any attributions must be accurately written for the articles that they appear in. -If you are unsure of the legality of reusing any content, contact legal. If you are adding content with a license that is not listed below, you must receive a legal review before you can publish the content. +If you are unsure of the legality of reusing any content, contact legal. If you are adding content with a license that is not listed here, you must receive a legal review before you can publish the content. ### Attributing MIT-licensed content @@ -1270,6 +1270,14 @@ To signal to readers that you've added or changed a note, or to indicate the pub To signal that we have removed a release note, add an "Errata" section detailing which note you removed and (if relevant) which version the removed note actually pertains to. See [Writing errata](#writing-errata). +## Release references + +When referring to a range of releases starting from a particular release, use "or later." + +* **Use:** "release 0.41.0 or later" +* **Avoid:** "release 0.41.0 or above" +* **Avoid:** "release 0.41.0 or greater" + ## Reusables and variables Use reusable strings for individual nouns (e.g. product names) or for complete sentences or paragraphs. Sentence fragments and phrases should not be contained in reusable strings as they can cause problems when content is localized. For more information, see the [data directory](https://github.com/github/docs/tree/main/data) in the [`github/docs`](https://github.com/github/docs) repository, [Creating reusable content](/contributing/writing-for-github-docs/creating-reusable-content), and the [Product names](#product-names) section of this document. diff --git a/src/dev-toc/generate.ts b/src/dev-toc/generate.ts index c53b9cc51cb0..5e6afa955ea5 100644 --- a/src/dev-toc/generate.ts +++ b/src/dev-toc/generate.ts @@ -1,3 +1,14 @@ +/** + * Development tool that generates a local Table of Contents (TOC) for the GitHub Docs website. + * + * This script creates static HTML files for each documentation version, renders page titles + * using Liquid templating, and opens the generated TOC in your browser for easy navigation + * during development. Supports command-line options to specify which sections should be + * open by default. + * + * Usage: tsx src/dev-toc/generate.ts [-o product-ids...] + */ + import fs from 'fs' import path from 'path' import { execSync } from 'child_process' diff --git a/src/dev-toc/layout.html b/src/dev-toc/layout.html index fca2aa106468..24d8fab8fccd 100644 --- a/src/dev-toc/layout.html +++ b/src/dev-toc/layout.html @@ -24,40 +24,69 @@

TOC for {{ allVersions[currentVersion].versio
+{% assign maxTocDepth = 5 %} + {% for productPage in currentEnglishTree.childPages %} -{% assign productId = productPage.page.relativePath | replace: "/index.md", "" %} -{% if defaultOpenSections contains productId %} -
{{productPage.renderedFullTitle}} -{% else %} -
{{productPage.renderedFullTitle}} -{% endif %} -
    -
  • - {{ productPage.renderedFullTitle }} - {% for categoryPage in productPage.childPages %} -
      -
    • - {{ categoryPage.renderedFullTitle }} -
        - {% for subcategoryPage in categoryPage.childPages %} + {% assign productId = productPage.page.relativePath | replace: "/index.md", "" %} + {% if defaultOpenSections contains productId %} +
        {{productPage.renderedFullTitle}} + {% else %} +
        {{productPage.renderedFullTitle}} + {% endif %} + + - -
      -
+ {% endfor %} + + {% endif %} + + +
{% endfor %} {% endif %}