feature/documentation#13
Conversation
This commit introduces the initial set of documentation pages for the TriggerX library, covering basic setup and usage.
Key new files and their purpose:
- **`docs/docs/tutorial-basics/1-installation.md`**:
- Provides instructions on how to install TriggerX using Gradle (Kotlin DSL) and Version Catalogs.
- Lists the required Android permissions: `REQUEST_IGNORE_BATTERY_OPTIMIZATIONS`, `SYSTEM_ALERT_WINDOW`, and `SCHEDULE_EXACT_ALARM`.
- **`docs/docs/tutorial-basics/2-set-custom-alarm-activity.md`**:
- Explains how to set a custom `Activity` (extending `TriggerXActivity`) that will be displayed when an alarm fires.
- Includes an example of a custom `AppAlarmActivity` with a Composable `AlarmContent` override for the UI.
- **`docs/docs/tutorial-basics/3-configure-triggerx-dsl.md`**:
- Details how to configure TriggerX using its Kotlin DSL within the `Application` class.
- Provides an example of initializing `TriggerX` by setting the `activityClass` and using `useDefaultNotification` for the foreground service notification.
- **`docs/docs/tutorial-basics/5-scheduling-alarm.md`**:
- Describes how to schedule an alarm using `TriggerXAlarmScheduler`.
- Includes a Composable `HomeScreen` example demonstrating how to schedule an alarm that triggers after 1 minute, passing `type` and `alarmId`.
- Briefly explains what happens behind the scenes when an alarm is scheduled and fires.
These new documentation pages aim to guide users through the initial steps of integrating and using the TriggerX library in their Android projects.
This commit updates the documentation by removing the "Manage Docs Versions" page and adding a new placeholder page for "Showing dynamic UI".
Key changes:
- **Deleted `docs/docs/tutorial-extras/manage-docs-versions.md`**:
- Removed the documentation page that explained how to manage multiple versions of docs using Docusaurus, including creating versions and adding a version dropdown.
- **Added `docs/docs/tutorial-extras/showing-dynamic-ui.md`**:
- Created a new, empty documentation page titled "Showing dynamic UI".
- Set its `sidebar_position` to `1`.
This commit updates the Docusaurus configuration and content for the TriggerX documentation website.
Key changes:
- **Configuration (`docusaurus.config.ts`):**
- Updated site `title` to "TriggerX Documentation".
- Updated `tagline` to "Trigger UI. On time. Every time.".
- Changed `organizationName` to "Meticha" and `projectName` to "triggerx".
- Removed the "Tutorial" and "Blog" links from the navbar.
- Updated the GitHub link in the navbar to point to the `meticha/triggerx` repository.
- Updated footer links:
- Removed "Stack Overflow".
- Updated Discord link to `https://discord.gg/p3SC9ZKzb6`.
- Updated X (formerly Twitter) link to `https://x.com/metichahq`.
- Removed "Blog" link.
- Updated GitHub link to `https://github.com/meticha`.
- Updated copyright to "Copyright © YYYY Meticha".
- **Homepage (`docs/src/pages/index.tsx`, `docs/src/components/HomepageFeatures/index.tsx`):**
- Changed the "Get Started" button text and link.
- Updated feature descriptions to be specific to TriggerX:
- "Easy to Use" changed to "✅ Time-Triggered UI That Just Works"
- "Focus on What Matters" changed to "⚙️ Fully Custom UI with Compose"
- "Powered by React" changed to "🔐 Handles Permissions So You Don’t Have To"
- **Styling (`docs/src/css/custom.css`):**
- Updated primary color palette for both light and dark themes.
- Set a specific background color for the dark theme.
- **Content Removal:**
- Deleted all blog posts and related files:
- `docs/blog/2019-05-28-first-blog-post.md`
- `docs/blog/2019-05-29-long-blog-post.md`
- `docs/blog/2021-08-01-mdx-blog-post.mdx`
- `docs/blog/2021-08-26-welcome/index.md`
- `docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg`
- `docs/blog/authors.yml`
- `docs/blog/tags.yml`
- Deleted the "Translate your site" tutorial page: `docs/docs/tutorial-extras/translate-your-site.md`.
- **Documentation Structure (`docs/docs/tutorial-extras/_category_.json`):**
- Renamed the "Tutorial - Extras" category label to "Advanced".
These changes focus the documentation on TriggerX, update branding, and streamline the content by removing the unused blog and specific Docusaurus tutorials.
This commit introduces several improvements to the documentation website's homepage UI and updates some documentation content.
Key changes:
- **Homepage UI Enhancements (`docs/src/components/HomepageFeatures/`):**
- **`styles.module.css`**: Added new CSS styles for feature cards (`.card`) and icons (`.icon`). Cards now have a background, border-radius, box-shadow, and hover effects (transform and shadow change). Icons have a larger font size and bottom margin.
- **`index.tsx`**:
- Replaced SVG icons with emoji icons for features.
- Updated the `FeatureItem` type to use `icon: ReactNode` instead of `Svg`.
- Modified the `Feature` component to use the new `icon` and apply the `.card` and `.icon` styles. The layout within each feature card is now centered.
- Removed the "✅" prefix from the "Time-Triggered UI That Just Works" feature title.
- **Docusaurus Configuration (`docs/docusaurus.config.ts`):**
- Changed the navbar title from "TriggerX Documentation" to "TriggerX".
- **Page Title (`docs/src/pages/index.tsx`):**
- Updated the homepage title to use only `siteConfig.title` instead of `Hello from ${siteConfig.title}`.
- **Documentation Content Updates:**
- **`docs/docs/tutorial-basics/1-installation.md`**: Removed the `SYSTEM_ALERT_WINDOW` permission from the list of required permissions.
- **`README.md`**: Removed the `SYSTEM_ALERT_WINDOW` permission from the list of required permissions in the main project README.
These changes aim to create a more visually appealing and modern homepage for the documentation, and ensure the permission documentation is accurate.
This commit introduces several improvements to the Docusaurus documentation website for TriggerX.
Key changes:
- **docusaurus.config.ts**:
- Updated `favicon` to `img/triggerx-logo.png`.
- Corrected `editUrl` for both docs and blog to point to the `meticha/triggerx` repository.
- Updated `image` (social card) to `img/triggerx-banner.png`.
- Updated `navbar.logo.src` to `img/triggerx-logo.png`.
- Added a "LinkedIn" link to the footer's social media section.
- **src/components/HomepageFeatures/styles.module.css**:
- Updated `.card` background to use `var(--ifm-card-background-color, var(--ifm-background-color))` for better theme adaptability.
- Set `.card` text color to `var(--ifm-font-color-base)`.
- Added comments to clarify CSS rules for card container, hover effect, and icon.
- **static/robots.txt**:
- Added a new `robots.txt` file to allow all user-agents to crawl the site (`User-agent: *`, `Disallow:`).
- **docs/tutorial-basics/5-scheduling-alarm.md**:
- Added an "Expected output" section with an embedded GIF (`/img/triggerx_example.gif`) demonstrating the TriggerX functionality. The GIF height is set to 600.
These changes enhance the visual branding, improve SEO, provide correct edit links, and add a visual example to the tutorial.
This commit updates the Docusaurus configuration (`docs/docusaurus.config.ts`) to prepare the documentation site for deployment. Key changes: - **`url`**: Changed from the placeholder `https://your-docusaurus-site.example.com` to `https://labs.meticha.com`. - **`trailingSlash`**: Set to `false`. - **`baseUrl`**: Changed from `/` to `/triggerx/docs/`. These changes configure the site's production URL and base path for proper deployment under the specified domain and subdirectory.
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the WalkthroughThis update introduces a comprehensive documentation site for the TriggerX library using Docusaurus. It adds configuration files, documentation content, React components for the homepage, CSS modules for styling, and supporting assets. The documentation covers installation, configuration, tutorials, permission handling, and example usage, and organizes content into structured categories. Additionally, the README was updated to remove a commented permission line. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant DocsSite
participant TriggerX Library
Developer->>DocsSite: Install dependencies (yarn)
Developer->>DocsSite: Start local dev server (yarn start)
Developer->>DocsSite: Build static site (yarn build)
Developer->>DocsSite: Deploy to GitHub Pages (yarn deploy)
Developer->>DocsSite: Read tutorials (installation, setup, scheduling)
DocsSite->>TriggerX Library: Show code/configuration examples
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (20)
docs/.gitignore (1)
1-21: Add missing newline and verify ignore patternsIt’s good to ignore build artifacts and logs, but consider adding a trailing newline for POSIX compliance. Also verify whether Docusaurus v2 generates a
.cachedirectory (in addition to.cache-loader) that should be ignored here.docs/src/css/custom.css (1)
19-28: Enhance dark mode withcolor-schemeAdd
color-scheme: dark;at the top of the[data-theme='dark']block so user agents render form controls and scrollbars appropriately in dark mode.Example:
[data-theme='dark'] { color-scheme: dark; --ifm-color-primary: #ffde22; /* … */ }docs/src/components/HomepageFeatures/styles.module.css (3)
1-6: Make features container responsiveConsider adding
flex-wrap: wrap;and a gap to ensure feature cards wrap on narrower viewports, improving mobile layout.Example:
.features { display: flex; flex-wrap: wrap; gap: 2rem; /* existing rules */ }
8-11: Use responsive sizing for SVGsFixed
200pxdimensions can overflow. Usemax-width: 100%; height: auto;or CSS variables to keep SVGs scalable within the layout.
25-28: Extend hover effect to focusMirror the hover transform and shadow in
:focus-visibleso keyboard navigation receives the same visual feedback.docs/docs/tutorial-extras/showing-dynamic-ui.md (1)
1-7: Add content scaffoldingThe frontmatter is in place, but the file lacks any body content. Consider adding an introductory paragraph, example code block, or at least a
TODOplaceholder to guide authors.Would you like me to generate a basic content scaffold?
docs/static/robots.txt (1)
1-2: Include sitemap directiveAllowing all crawlers is fine, but adding a
Sitemap: /sitemap.xmldirective can improve SEO by guiding bots directly to your sitemap.docs/src/pages/index.tsx (2)
21-27: UseuseBaseUrlfor consistent routing.
Leverage Docusaurus’suseBaseUrlhelper to resolve the docs path dynamically.Proposed diff:
-import Link from '@docusaurus/Link'; +import Link from '@docusaurus/Link'; +import {useBaseUrl} from '@docusaurus/useBaseUrl'; ... - <Link - className="button button--secondary button--lg" - to="/docs/intro"> + <Link + className="button button--secondary button--lg" + to={useBaseUrl('docs/intro')}> Get Started️ </Link>
35-37: Simplify template string intitleprop.
You can pass the site title directly instead of wrapping it in a template literal.- title={`${siteConfig.title}`} + title={siteConfig.title}docs/docs/tutorial-basics/2-set-custom-alarm-activity.md (1)
7-14: Fix minor typos and improve readability.
- Add the missing article “the” for background.
- Correct the casing of
TriggerXActivity.- entry point for your UI, even when the app is killed or in background. + entry point for your UI, even when the app is killed or in the background. - Once you extend your class with `TriggerXActivity`, you can override the `AlarmContent` composable + Once you extend your class with `TriggerXActivity`, you can override the `AlarmContent` composable - Also, since `TriggerxActivity` extends the `ComponentActivity` itself, you can also do all sorts of stuff... + Also, since `TriggerXActivity` extends the `ComponentActivity` itself, you can also do all sorts of things...🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: You might be missing the article “the” here.
Context: ...r UI, even when the app is killed or in background. Once you extend your class with `Trig...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/src/components/HomepageFeatures/index.tsx (3)
12-40: Ensure icon accessibility.
Raw emoji strings lack screen-reader context. Wrap eachiconin a semantic element, e.g.:icon: <span role="img" aria-label="Alarm clock">⏰</span>
42-54: Optimize CSS class usage.
You're usingclsxfor static class names; you can simplify:- <div className={clsx('col col--4')}> + <div className="col col--4">and similarly for padding.
61-63: Use stable keys instead of index.
Replacekey={idx}with a unique prop (e.g.,props.title) to avoid rerender issues:- {FeatureList.map((props, idx) => ( - <Feature key={idx} {...props} /> - ))} + {FeatureList.map((props) => ( + <Feature key={props.title} {...props} /> + ))}docs/docs/tutorial-basics/3-configure-triggerx-dsl.md (2)
2-5: Quote frontmatter strings containing backticks.
YAML can misinterpret inline code literals. Wrap thedescriptionvalue in quotes:- description: Setting up TriggerX is as simple as declaring what you want—literally. Using a `Kotlin DSL` + description: "Setting up TriggerX is as simple as declaring what you want—literally. Using a `Kotlin DSL`"
19-33: Add import statements for the snippet.
Help users drop this into their project by including:import android.app.Application import com.triggerx.TriggerXdocs/docs/tutorial-basics/5-scheduling-alarm.md (1)
13-65: Include necessary imports in the example.
Add Compose and Android API imports so readers can copy-paste:import androidx.compose.runtime.Composable import androidx.compose.ui.platform.LocalContext import androidx.compose.material3.* import com.triggerx.TriggerXAlarmScheduler import android.widget.Toast import java.util.Calendardocs/docs/intro.md (3)
9-10: Fix infinitive form for clarity.Change “you don’t need worry about managing” to “you don’t need to worry about managing” to correct the missing “to” before the verb.
🧰 Tools
🪛 LanguageTool
[grammar] ~9-~9: The verb “worry” needs to be in the to-infinitive form.
Context: ...hen your App has been killed. You don't need worry about managing foreground-services, wak...(MISSING_TO_BEFORE_A_VERB)
20-20: Tone down informal phrasing.Consider replacing “Way too many times.” with a more professional alternative like “On numerous occasions.”
🧰 Tools
🪛 LanguageTool
[style] ~20-~20: The expression “Way too many” can be considered informal. Consider replacing the phrase to sound more professional.
Context: ...n. Just silence. We’ve been there too. Way too many times. At [Meticha](https://meticha.co...(WAY_TOO_MUCH)
38-38: Reduce wordiness.You might shorten “so you’re always in control of what the user sees and when” to “so you control what the user sees and when.”
🧰 Tools
🪛 LanguageTool
[style] ~38-~38: ‘in control of’ might be wordy. Consider a shorter alternative.
Context: ...sion flows gracefully, so you’re always in control of what the user sees and when. TriggerX ...(EN_WORDINESS_PREMIUM_IN_CONTROL_OF)
docs/docusaurus.config.ts (1)
48-50: Extract repeatededitUrlinto a constant.Avoid duplication by defining a shared base URL, e.g.:
+const repoEditBase = 'https://github.com/meticha/triggerx/tree/main/docs'; ... - editUrl: - 'https://github.com/meticha/triggerx/tree/main/docs/docs', + editUrl: `${repoEditBase}/docs`, ... - editUrl: - 'https://github.com/meticha/triggerx/tree/main/docs/docs', + editUrl: `${repoEditBase}/docs`,Also applies to: 59-61
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (8)
docs/docs/tutorial-extras/img/docsVersionDropdown.pngis excluded by!**/*.pngdocs/docs/tutorial-extras/img/localeDropdown.pngis excluded by!**/*.pngdocs/package-lock.jsonis excluded by!**/package-lock.jsondocs/static/img/docusaurus-social-card.jpgis excluded by!**/*.jpgdocs/static/img/docusaurus.pngis excluded by!**/*.pngdocs/static/img/trigerx-banner.pngis excluded by!**/*.pngdocs/static/img/triggerx-logo.pngis excluded by!**/*.pngdocs/static/img/triggerx_example.gifis excluded by!**/*.gif
📒 Files selected for processing (23)
README.md(0 hunks)docs/.gitignore(1 hunks)docs/README.md(1 hunks)docs/docs/intro.md(1 hunks)docs/docs/tutorial-basics/1-installation.md(1 hunks)docs/docs/tutorial-basics/2-set-custom-alarm-activity.md(1 hunks)docs/docs/tutorial-basics/3-configure-triggerx-dsl.md(1 hunks)docs/docs/tutorial-basics/4-permission-handling.mdx(1 hunks)docs/docs/tutorial-basics/5-scheduling-alarm.md(1 hunks)docs/docs/tutorial-basics/_category_.json(1 hunks)docs/docs/tutorial-extras/_category_.json(1 hunks)docs/docs/tutorial-extras/showing-dynamic-ui.md(1 hunks)docs/docusaurus.config.ts(1 hunks)docs/package.json(1 hunks)docs/sidebars.ts(1 hunks)docs/src/components/HomepageFeatures/index.tsx(1 hunks)docs/src/components/HomepageFeatures/styles.module.css(1 hunks)docs/src/css/custom.css(1 hunks)docs/src/pages/index.module.css(1 hunks)docs/src/pages/index.tsx(1 hunks)docs/src/pages/markdown-page.md(1 hunks)docs/static/robots.txt(1 hunks)docs/tsconfig.json(1 hunks)
💤 Files with no reviewable changes (1)
- README.md
🧰 Additional context used
🧬 Code Graph Analysis (1)
docs/src/pages/index.tsx (1)
docs/src/components/HomepageFeatures/index.tsx (1)
HomepageFeatures(56-68)
🪛 LanguageTool
docs/src/pages/markdown-page.md
[grammar] ~7-~7: Did you mean “to React”?
Context: ...# Markdown page example You don't need React to write simple standalone pages.
(NEEDNT_TO_DO_AND_DONT_NEED_DO)
docs/docs/tutorial-basics/4-permission-handling.mdx
[grammar] ~44-~44: Did you mean “Does track” (emphatic ‘do’) or “tracks”?
Context: ... } } } ``` ## 💡 What This Does - rememberAppPermissionState() tracks the required permissions - On button ta...
(DOES_VBZ_DT)
docs/docs/intro.md
[grammar] ~9-~9: The verb “worry” needs to be in the to-infinitive form.
Context: ...hen your App has been killed. You don't need worry about managing foreground-services, wak...
(MISSING_TO_BEFORE_A_VERB)
[style] ~20-~20: The expression “Way too many” can be considered informal. Consider replacing the phrase to sound more professional.
Context: ...n. Just silence. We’ve been there too. Way too many times. At [Meticha](https://meticha.co...
(WAY_TOO_MUCH)
[style] ~38-~38: ‘in control of’ might be wordy. Consider a shorter alternative.
Context: ...sion flows gracefully, so you’re always in control of what the user sees and when. TriggerX ...
(EN_WORDINESS_PREMIUM_IN_CONTROL_OF)
docs/docs/tutorial-basics/2-set-custom-alarm-activity.md
[uncategorized] ~9-~9: You might be missing the article “the” here.
Context: ...r UI, even when the app is killed or in background. Once you extend your class with `Trig...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🔇 Additional comments (26)
docs/src/css/custom.css (1)
8-16: Verify contrast for light theme overridesYour custom primary palette overrides look consistent. Please confirm that they meet accessibility (WCAG AA) contrast standards against default backgrounds.
docs/src/components/HomepageFeatures/styles.module.css (1)
31-34: Approve icon stylingIcon size and margin are well chosen for clear visual hierarchy.
docs/docs/tutorial-extras/_category_.json (1)
1-7: Category JSON is correctly defined.
The new "Advanced" section with a generated-index link fits with the existing category structure.docs/tsconfig.json (1)
1-8: Editor-only tsconfig is valid.
Extending@docusaurus/tsconfig, settingbaseUrl, and excluding build artifacts will improve IDE support without impacting the Docusaurus build.docs/docs/tutorial-basics/_category_.json (1)
1-8: Basics category configuration looks good.
The label, position, generated-index link, and descriptive text accurately organize the tutorial-basics content.docs/src/pages/markdown-page.md (1)
1-8: Standalone markdown page is well-structured.
Frontmatter is correct and the content clearly explains that React isn’t required for simple pages.🧰 Tools
🪛 LanguageTool
[grammar] ~7-~7: Did you mean “to React”?
Context: ...# Markdown page example You don't need React to write simple standalone pages.(NEEDNT_TO_DO_AND_DONT_NEED_DO)
docs/src/pages/index.module.css (1)
6-23: CSS module styling is appropriate.
.heroBannerand.buttonsstyles align with the homepage layout, and the responsive padding tweak ensures mobile friendliness.docs/docs/tutorial-basics/1-installation.md (4)
1-5: Front matter and introduction look good.
The metadata and initial explanation are clear and correctly formatted.
14-18: Kotlin dependency snippet is correct.
The Gradle Kotlin DSL example is accurate and easy to follow.
25-30: Version Catalog example is valid.
Thelibs.versions.tomland usage inbuild.gradle.ktsare properly demonstrated.
39-47: Required permissions section is clear.
The XML snippet for battery optimizations and exact alarms is accurate.docs/README.md (6)
1-4: Project README header and intro are solid.
The description of Docusaurus and project context is concise.
7-9: Installation instructions are clear.
Runningyarnis the standard setup step.
13-15: Local development section is correct.
yarn startdetails are accurate and user-friendly.
21-23: Build instructions are accurate.
Generating the static site withyarn buildis well documented.
31-33: SSH deployment instructions are fine.
UsingUSE_SSH=true yarn deployaligns with Docusaurus defaults.
37-39: Non-SSH deployment instructions are fine.
SpecifyingGIT_USERcovers scenarios where SSH is unavailable.docs/src/pages/index.tsx (2)
1-9: Import section is well-organized.
Type imports, dependencies, and local modules follow a logical order.
11-30:HomepageHeaderJSX structure is correct.
The hero banner markup, use ofHeading, and button are implemented as expected.docs/docs/tutorial-basics/4-permission-handling.mdx (3)
1-5: Front matter is properly defined.
Title, description, and sidebar position are clear and well-formatted.
13-42: Compose permission-handling example is accurate.
Kotlin code snippet correctly demonstratesrememberAppPermissionState()usage.
44-49: Explanation section is clear.
The bullet list concisely describes what the helper does and the control flow.🧰 Tools
🪛 LanguageTool
[grammar] ~44-~44: Did you mean “Does track” (emphatic ‘do’) or “tracks”?
Context: ... } } } ``` ## 💡 What This Does -rememberAppPermissionState()tracks the required permissions - On button ta...(DOES_VBZ_DT)
docs/docs/tutorial-basics/2-set-custom-alarm-activity.md (1)
19-65: Code example is clear and comprehensive.
The Kotlin snippet demonstrates extendingTriggerXActivityand composing UI correctly.docs/src/components/HomepageFeatures/index.tsx (2)
1-4: Imports look correct.
All necessary React types,clsx, DocusaurusHeading, and CSS module are imported.
6-10: FeatureItem type definition is clear.
The shape of each feature (title,icon,description) is well-typed.docs/sidebars.ts (1)
1-3: Sidebar configuration is correct.
The autogeneratedtutorialSidebarwill pick up all docs underdocs/.
This commit introduces several improvements to the documentation website, including styling updates for homepage features, dark mode enhancements, and minor content corrections.
Key changes:
- **docs/src/components/HomepageFeatures/styles.module.css**:
- Added `flex-wrap: wrap` to the `.features` class to allow features to wrap on smaller screens.
- **docs/src/components/HomepageFeatures/index.tsx**:
- Changed the `key` for `Feature` components from `idx` to `props.title` for better stability.
- Removed `clsx` from the `Feature` component's root div class assignment as it was not necessary.
- **docs/docs/tutorial-basics/2-set-custom-alarm-activity.md**:
- Corrected "in background" to "in the background".
- Corrected "all sorts of stuff" to "all sorts of things".
- **docs/src/css/custom.css**:
- Added `color-scheme: dark;` to the `[data-theme='dark']` rule to improve dark mode styling.
- **docs/docs/intro.md**:
- Corrected "need worry" to "need to worry".
- **docs/docusaurus.config.ts**:
- Removed the `blog` configuration section as it's not currently used.
- **docs/docs/tutorial-basics/5-scheduling-alarm.md**:
- Updated the image path for `triggerx_example.gif` to include the base path `/triggerx/docs/`.
- **docs/docs/tutorial-basics/3-configure-triggerx-dsl.md**:
- Updated the `description` metadata.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
docs/docs/intro.md (4)
5-11: Convert inline feature list into a bulleted list & unify hyphenation
For better readability, list “foreground services”, “wake locks”, “lock-screen flags”, and “permission management” as bullets. Also remove unnecessary hyphens and add a period at the end of the sentence.
20-20: Rephrase informal language
The expression “Way too many times” can sound informal; consider “too many times” or a more professional alternative.🧰 Tools
🪛 LanguageTool
[style] ~20-~20: The expression “Way too many” can be considered informal. Consider replacing the phrase to sound more professional.
Context: ...n. Just silence. We’ve been there too. Way too many times. At [Meticha](https://meticha.co...(WAY_TOO_MUCH)
8-8: Ensure consistent casing for “app”
The term “App” is capitalized mid-sentence; consider using lowercase “app” unless it’s intended as a proper noun.
38-39: Simplify phrase for brevity
“In control of what the user sees and when” is wordy; consider “in control of the user experience.”🧰 Tools
🪛 LanguageTool
[style] ~38-~38: ‘in control of’ might be wordy. Consider a shorter alternative.
Context: ...sion flows gracefully, so you’re always in control of what the user sees and when. TriggerX ...(EN_WORDINESS_PREMIUM_IN_CONTROL_OF)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
docs/docs/intro.md(1 hunks)docs/docs/tutorial-basics/2-set-custom-alarm-activity.md(1 hunks)docs/docs/tutorial-basics/3-configure-triggerx-dsl.md(1 hunks)docs/docs/tutorial-basics/5-scheduling-alarm.md(1 hunks)docs/docusaurus.config.ts(1 hunks)docs/src/components/HomepageFeatures/index.tsx(1 hunks)docs/src/components/HomepageFeatures/styles.module.css(1 hunks)docs/src/css/custom.css(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (7)
- docs/src/css/custom.css
- docs/src/components/HomepageFeatures/styles.module.css
- docs/docs/tutorial-basics/3-configure-triggerx-dsl.md
- docs/docs/tutorial-basics/2-set-custom-alarm-activity.md
- docs/src/components/HomepageFeatures/index.tsx
- docs/docs/tutorial-basics/5-scheduling-alarm.md
- docs/docusaurus.config.ts
🧰 Additional context used
🪛 LanguageTool
docs/docs/intro.md
[style] ~20-~20: The expression “Way too many” can be considered informal. Consider replacing the phrase to sound more professional.
Context: ...n. Just silence. We’ve been there too. Way too many times. At [Meticha](https://meticha.co...
(WAY_TOO_MUCH)
[style] ~38-~38: ‘in control of’ might be wordy. Consider a shorter alternative.
Context: ...sion flows gracefully, so you’re always in control of what the user sees and when. TriggerX ...
(EN_WORDINESS_PREMIUM_IN_CONTROL_OF)
🔇 Additional comments (2)
docs/docs/intro.md (2)
28-36: Well-structured Play Store section
This section clearly addresses permissions and aligns with Docusaurus styling and user expectations.
41-42: Engaging closing statement
The final tagline reinforces TriggerX’s value proposition effectively.
This commit removes two unused image files related to Docusaurus from the `docs/static/img` directory. Key changes: - **docs/static/img/docusaurus.png**: Deleted. - **docs/static/img/docusaurus-social-card.jpg**: Deleted.
2 participants
Summary by CodeRabbit
.gitignoreandrobots.txtfiles for improved project management and search engine indexing.