mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-09-16 15:19:36 -04:00
docs: publish channels: main
This commit is contained in:
1 parent
58c1c239a5
commit
4b7cf9539b
9 files changed
+9
-9
No files matched your search
File diff suppressed because one or more lines are too long.
File diff suppressed because one or more lines are too long.
File diff suppressed because one or more lines are too long.
File diff suppressed because one or more lines are too long.
File diff suppressed because one or more lines are too long.
@@ -9535,7 +9535,7 @@
|
||||
},"1362": {
|
||||
"doc": "Documentation Style",
|
||||
"title": "New Page Checklist",
|
||||
"content": ". | Create docs/en/user/<slug>.md or docs/en/developer/<slug>.md with complete frontmatter (STRUCT-1). | Register the page in feature/docs/.../data/DocBundleLoader.kt with keywords and aliases. | Put screenshots in docs/assets/screenshots/, referenced per IMG-1. | Add a What’s New entry (STRUCT-6). | Validate locally: node scripts/validate-doc-links.js docs/en, node scripts/check-doc-coverage.js ., and the docs bundle Gradle checks in Contributing. | . ",
|
||||
"content": ". | Create docs/en/user/<slug>.md or docs/en/developer/<slug>.md with complete frontmatter (STRUCT-1). | Register the page in feature/docs/.../data/DocBundleLoader.kt with keywords and aliases. | Put screenshots in docs/assets/screenshots/, referenced per IMG-1. | Add a What’s New entry (STRUCT-6). | Validate locally: node scripts/validate-doc-links.js docs/en, node scripts/check-doc-coverage.js ., node scripts/check-doc-aliases.js . (every alias in step 1’s frontmatter must also be in step 2’s loader entry — only the loader’s list reaches in-app search), and the docs bundle Gradle checks in Contributing. | . ",
|
||||
"url": "/Meshtastic-Android/main/en/developer/documentation-style.html#new-page-checklist",
|
||||
|
||||
"relUrl": "/en/developer/documentation-style.html#new-page-checklist"
|
||||
|
||||
@@ -148,7 +148,7 @@ Where this guide deviates from the external guides it synthesizes, the deviation
|
||||
2. Register the page in `feature/docs/.../data/DocBundleLoader.kt` with keywords and aliases.
|
||||
3. Put screenshots in `docs/assets/screenshots/`, referenced per IMG-1.
|
||||
4. Add a *What's New* entry (STRUCT-6).
|
||||
5. Validate locally: `node scripts/validate-doc-links.js docs/en`, `node scripts/check-doc-coverage.js .`, and the docs bundle Gradle checks in [Contributing](contributing).
|
||||
5. Validate locally: `node scripts/validate-doc-links.js docs/en`, `node scripts/check-doc-coverage.js .`, `node scripts/check-doc-aliases.js .` (every alias in step 1's frontmatter must also be in step 2's loader entry — only the loader's list reaches in-app search), and the docs bundle Gradle checks in [Contributing](contributing).
|
||||
|
||||
## Related Topics
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long.
+1
-1
@@ -24,7 +24,7 @@
|
||||
{"id":"architecture","title":"Architecture","section":"developer","locale":"en","resourcePath":"docs/developer/architecture.html","navOrder":1,"keywords":["architecture", "layer", "overview", "module", "categories", "androidapp", "android", "application", "desktopapp", "desktop", "jvm", "feature", "modules", "core", "kmp", "source", "sets", "dependency", "injection", "radio", "control", "service", "repository", "navigation"],"aliases":["layers", "module-architecture", "kmp", "radio-control"],"charCount":7725},
|
||||
{"id":"codebase","title":"Codebase","section":"developer","locale":"en","resourcePath":"docs/developer/codebase.html","navOrder":2,"keywords":["codebase", "repository", "structure", "namespacing", "convention", "build", "system", "gradle", "kotlin", "dsl", "plugins", "variants", "android", "key", "tasks", "compile", "check", "across", "all", "kmp", "targets", "run", "tests", "code", "quality", "desktop", "native", "installers", "for", "the"],"aliases":["repository-layout", "project-structure", "source-code"],"charCount":4876},
|
||||
{"id":"contributing","title":"Contributing","section":"developer","locale":"en","resourcePath":"docs/developer/contributing.html","navOrder":8,"keywords":["contributing", "branch", "naming", "development", "workflow", "commit", "messages", "pull", "request", "checklist", "code", "style", "architecture", "rules", "verification", "getting", "help"],"aliases":["contributing", "pull-request", "branch-naming"],"charCount":3466},
|
||||
{"id":"documentation-style","title":"Documentation Style","section":"developer","locale":"en","resourcePath":"docs/developer/documentation-style.html","navOrder":11,"keywords":["documentation", "style", "voice", "and", "tone", "language", "word", "list", "headings", "page", "structure", "admonitions", "procedures", "links", "images", "code", "developer", "pages", "decisions", "why", "new", "checklist", "related", "topics"],"aliases":["style", "style-guide", "docs-style", "writing"],"charCount":15289},
|
||||
{"id":"documentation-style","title":"Documentation Style","section":"developer","locale":"en","resourcePath":"docs/developer/documentation-style.html","navOrder":11,"keywords":["documentation", "style", "voice", "and", "tone", "language", "word", "list", "headings", "page", "structure", "admonitions", "procedures", "links", "images", "code", "developer", "pages", "decisions", "why", "new", "checklist", "related", "topics"],"aliases":["style", "style-guide", "docs-style", "writing"],"charCount":15451},
|
||||
{"id":"measurement","title":"Measurement & Formatting","section":"developer","locale":"en","resourcePath":"docs/developer/measurement.html","navOrder":9,"keywords":["measurement", "formatting", "overview", "metricformatter", "api", "usage", "numberformatter", "unit", "conversion", "adding", "new", "type", "dateformatter", "design", "decisions", "related"],"aliases":["measurement", "metric-formatter", "number-formatter"],"charCount":8029},
|
||||
{"id":"navigation-and-deep-links","title":"Navigation & Deep Links","section":"developer","locale":"en","resourcePath":"docs/developer/navigation-and-deep-links.html","navOrder":4,"keywords":["navigation", "deep", "links", "route", "architecture", "hierarchy", "conventions", "link", "router", "uri", "format", "supported", "backstack", "synthesis", "adding", "entry", "registration", "testing"],"aliases":["deeplinks", "navigation-3", "routes"],"charCount":7230},
|
||||
{"id":"persistence","title":"Persistence","section":"developer","locale":"en","resourcePath":"docs/developer/persistence.html","navOrder":6,"keywords":["persistence", "room", "kmp", "database", "key", "points", "what", "stored", "datastore", "preferences", "core", "prefs", "docs", "intentionally", "skip", "best", "practices"],"aliases":["room", "database", "datastore", "prefs"],"charCount":3670},
|
||||
|
||||
Reference in new issue
Block a user