docs(notebooks): Document GFM task list syntax#17596
Open
inkeep[bot] wants to merge 1 commit into
Open
Conversation
Reflects PR #63320 which adds full GFM task list support to markdown notebooks. Updates the Text section to show both unchecked (- [ ]) and checked (- [x]) task list syntax instead of the old [] shorthand.
Contributor
Deploy preview
|
Contributor
|
Vale prose linter → found 0 errors, 32 warnings, 0 suggestions in your markdown Full report → Copy the linter results into an LLM to batch-fix issues. Linter being weird? Update the rules!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 14:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 16:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 18:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 20:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 22:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 24:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 26:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 28:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 30:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 32:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 34:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 36:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 38:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 40:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 42:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 44:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 46:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 48:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 50:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 52:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 54:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 56:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 116:7 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 145:166 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 154:62 | warning | Use bold (text) for UI elements, not quotes. | PostHogDocs.UIBoldNotQuotes |
| 154:155 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 154:205 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 163:5 | warning | 'Feature flags' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 163:5 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 167:166 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 211:93 | warning | Avoid trivializing words. 'easily' can sound dismissive to the reader. | PostHogDocs.Trivializers |
| 211:128 | warning | Use American English. Use 'organization' instead of 'organisation'. | PostHogBase.AmericanEnglish |
Contributor
|
Hey @mariusandra! This docs PR was generated for you by an agent. You're responsible for reviewing and merging it into production.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Updates the notebooks documentation to properly document the GFM task list syntax (
- [ ]and- [x]) that was added in PostHog/posthog#63320.Before:
After:
This reflects the new bidirectional GFM task list support in markdown notebooks, which allows users to:
- [ ](unchecked) and- [x](checked) syntax[],[ ], or[x]in an empty paragraph to create a task listThis PR was created by the Inkeep Content Writer agent, which is maintained by the Docs and Wizard team. Please reach out on Slack for help if needed.