Skip to content

Commit

Permalink
Initial google codelabs setup
Browse files Browse the repository at this point in the history
  • Loading branch information
ikarenkov committed Oct 23, 2024
1 parent 6dff8e7 commit d8d95e6
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 2 deletions.
19 changes: 17 additions & 2 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build documentation
name: Build and Deploy Writerside + CodeLabs

on:
push:
Expand All @@ -23,6 +23,17 @@ jobs:
with:
fetch-depth: 0

# Step to Install claat
- name: Install claat tool
run: go install github.com/googlecodelabs/tools/claat@latest

# Step to Generate CodeLab HTML Files
- name: Generate CodeLabs content
run: |
mkdir -p codelabs
claat export codelabs/workshop/workshop-codelab.md -o codelabs-generated
# Writerside build step
- name: Build docs using Writerside Docker builder
uses: JetBrains/writerside-github-action@v4
with:
Expand Down Expand Up @@ -52,9 +63,13 @@ jobs:
with:
name: docs

- name: Unzip artifact
- name: Unzip Writerside artifact
run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir

# Inject CodeLab HTML into Writerside docs
- name: Copy CodeLabs to Writerside output
run: cp -R codelabs-generated/* dir/

- name: Setup Pages
uses: actions/[email protected]

Expand Down
1 change: 1 addition & 0 deletions .idea/codeStyles/Project.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions codelabs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Codelabs

Codelabs are interactive tutorials that run in the browser. This directory contains the source files for
the [Google codelabs](https://github.com/googlecodelabs/tools).
62 changes: 62 additions & 0 deletions codelabs/workshop/workshop-codelab.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
author: Igor Karenkov
summary: Get known with Modo library for navigation in Jetpack Compose
id: modo-get-started-codelab
environments: Android
status: Published
feedback link: https://github.com/ikarenkov/Modo/issues

# Modo - get started Workshop

## Welcome to Modo Workshop

This workshop will guide you through the basics of Modo library for navigation in Jetpack Compose.

At the end of this workshop you will have a good sample application with Modo navigation that covers common use cases that can be found in real-world
applications.

You will learn:

1. Core concepts of Modo
2. How to setup Modo in your project
3. How to use Modo for stack navigation
4. How to use Modo for tab navigation
5. How to use Modo for navigation inside flow
6. How to use Modo for dialogs
7. How to use Modo with ViewModel and DI

## Core concepts

Please, follow this [link](https://ikarenkov.github.io/Modo/core-concepts.html) to learn more about core concepts of Modo library.

Make sure that you know that:

1. Navigation is defined by state
2. To update state you need to dispatch an action

## Library setup

TODO

## Stack Navigation

TODO

## Tab Navigation

TODO

## Navigation inside flow

TODO

## Dialogs

TODO

## ViewModel and DI

TODO

## Conclusion

TODO

0 comments on commit d8d95e6

Please sign in to comment.