-
Notifications
You must be signed in to change notification settings - Fork 7
/
mkdocs.yml
144 lines (144 loc) · 7.36 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
site_name: Neon.AI® Documentation
site_url: https://neongeckocom.github.io/neon-docs
plugins:
- search
theme:
logo: assets/neon_logo_transparent.svg
favicon: assets/favicon.png
name: material
features:
- search.suggest
- search.highlight
- search.share
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep orange
accent: orange
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep orange
accent: orange
toggle:
icon: material/brightness-4
name: Switch to light mode
nav:
- About: index.md
- Overview:
- Definitions: overview/definitions
- Frequently Asked Questions: overview/faq
- Neon Core:
- Introduction: neon_core/index.md
- Quick Start: neon_core/quick_start.md
- Core Modules:
- Introduction: neon_core/index.md
- Messagebus: neon_core/neon_messagebus.md
- Speech: neon_core/neon_speech.md
- Audio: neon_core/neon_audio.md
# - Skills: neon_core/neon_skills.md TODO: Add page
- GUI: neon_core/neon_gui.md
- Enclosure: neon_core/neon_enclosure.md
- Neon OS:
- Introduction: neon_os/index.md
- Installation: neon_os/neon_os_installation.md
- Using Neon OS: neon_os/using_neon_os.md
- Updating: neon_os/neon_os_updates.md
- Neon OS on the Mark II: neon_os/On_the_MarkII.md
- Debos Images: neon_os/neon_debos.md
- Developer References: neon_os/developers.md
- Tips: neon_os/tips.md
- DIANA:
- Backend Installation: diana/backend.md
- Quick Reference Guides:
- Terminal: quick_reference/terminal.md
- Logs: quick_reference/logging.md
- Configuration: quick_reference/configuration.md
- Installing Skills: quick_reference/installing_skills.md
- Installing Plugins: quick_reference/installing_plugins.md
- Metrics: quick_reference/metrics.md
- Skill Development:
- Voice User Interface Design Guidelines:
- What Can A Skill Do?: skill_development/voice-user-interface-design-guidelines/what-can-a-skill-do.md
- Design Process: skill_development/voice-user-interface-design-guidelines/design-process.md
- Interactions:
- Statements and Prompts: skill_development/voice-user-interface-design-guidelines/interactions-and-guidelines/statements-and-prompts.md
- Confirmations: skill_development/voice-user-interface-design-guidelines/interactions-and-guidelines/confirmations.md
- Conversations: skill_development/voice-user-interface-design-guidelines/conversations.md
- Error Handling: skill_development/voice-user-interface-design-guidelines/error-handling.md
- Example Interaction Script: skill_development/voice-user-interface-design-guidelines/example-dialogs.md
- Prototyping: skill_development/voice-user-interface-design-guidelines/prototyping.md
- Skill Testing: skill_development/voice-user-interface-design-guidelines/skill-testing.md
- Development Setup:
- Overview: skill_development/development-setup/overview.md
- Working with Git(Hub): skill_development/development-setup/git_overview.md
- Python Resources: skill_development/development-setup/python-resources.md
- Setting Up Your Development Environment: skill_development/development-setup/dev-environment.md
- Your First Skill: skill_development/development-setup/your-first-skill.md
- Skill Structure:
- Overview: skill_development/skill-structure/overview.md
- Lifecycle Methods: skill_development/skill-structure/lifecycle-methods.md
- Logging: skill_development/skill-structure/logging.md
- Skill Settings: skill_development/skill-structure/skill-settings.md
- Dependencies:
- skill.json: skill_development/development-setup/skill_json.md
- Manifest.yml: skill_development/skill-structure/dependencies/manifest-yml.md
- Requirements files: skill_development/skill-structure/dependencies/requirements-files.md
- Filesystem Access: skill_development/skill-structure/filesystem.md
- Skill API: skill_development/skill-structure/api.md
- Language Support:
- Using nice date and time functions for your language: skill_development/language-support/using-nice-date-and-time-functions-for-your-language.md
- User Interaction:
- Overview: skill_development/user-interaction/overview.md
- Intents:
- Overview: skill_development/user-interaction/intents/overview.md
- Adapt Intents: skill_development/user-interaction/intents/adapt-intents.md
- Padatious Intents: skill_development/user-interaction/intents/padatious-intents.md
- Statements: skill_development/user-interaction/statements.md
- Prompts: skill_development/user-interaction/prompts.md
- Parsing Utterances: skill_development/user-interaction/parsing.md
- Confirmations: skill_development/user-interaction/confirmations.md
- Conversational Context: skill_development/user-interaction/conversational-context.md
- Converse: skill_development/user-interaction/converse.md
- Displaying Information:
- GUI Framework: skill_development/displaying-information/mycroft-gui.md
- Show Simple Content: skill_development/displaying-information/show-simple-content.md
- Neon-GUI On A PC: skill_development/displaying-information/neon-gui-on-a-pc.md
- Advanced Skill Types:
- Overview: skill_development/skill-types/overview.md
- Fallback Skill: skill_development/skill-types/fallback-skill.md
- OVOS Common Play Skills: skill_development/skill-types/ovos-common-play.md
- Common Query Framework: skill_development/skill-types/common-query-framework.md
- Voice User Interfaces for PHAL Plugins: skill_development/skill-types/vuis-for-phal-plugins.md
- Skill Testing:
- Introduction: skill_development/testing/index.md
- GitHub Actions: skill_development/testing/github_actions.md
- DevOps:
- Repository Branches and Releases: operations/repository_structure.md
- Code Quality Standards: operations/qa_standards.md
- Workflows:
- Neon OS:
- Stable Release Workflow: operations/neon_os/workflow_stable_release.md
- Beta Release Workflow: operations/neon_os/workflow_beta_release.md
- Remove a Release Workflow: operations/neon_os/workflow_remove_release.md
- Library Modules:
- Stable Release Workflow: operations/libraries/workflow_stable_release.md
- Alpha Release Workflow: operations/libraries/workflow_alpha_release.md
- Stable Release Review Workflow: operations/libraries/workflow_review_stable.md
- Alpha Release Review Workflow: operations/libraries/workflow_review_alpha.md
- Git:
- Undo a Stable PR Workflow: operations/git/undo_stable_pr.md
- Triage New GitHub Issues: operations/git/triage_issues.md
- Skills:
- Stable Release Workflow: operations/skills/workflow_stable_release.md
- Alpha Release Workflow: operations/skills/workflow_alpha_release.md
- Review Workflow: operations/skills/workflow_review.md