Skip to content

Commit

Permalink
Cleanup website (#755)
Browse files Browse the repository at this point in the history
* Rewrite relnotes

* Cleanup

* Update idea configuration
  • Loading branch information
jisungbin committed Jun 11, 2023
1 parent 5c92c27 commit d299d44
Show file tree
Hide file tree
Showing 58 changed files with 1,305 additions and 632 deletions.
8 changes: 7 additions & 1 deletion website/.gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
.idea
**/.idea/*
!/.idea/icon.png
!/.idea/vcs.xml
!/.idea/copyright
!/.idea/codeStyleSettings.xml
!/.idea/codeStyles
!/.idea/dictionaries
node_modules
build
.docusaurus
Expand Down
31 changes: 31 additions & 0 deletions website/.idea/codeStyles/Project.xml

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

5 changes: 5 additions & 0 deletions website/.idea/codeStyles/codeStyleConfig.xml

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

7 changes: 7 additions & 0 deletions website/.idea/copyright/MIT.xml

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

7 changes: 7 additions & 0 deletions website/.idea/copyright/profiles_settings.xml

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

6 changes: 6 additions & 0 deletions website/.idea/vcs.xml

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

7 changes: 7 additions & 0 deletions website/babel.config.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
/*
* Designed and developed by Duckie Team 2023.
*
* Licensed under the MIT.
* Please see full license: https://github.com/duckie-team/quack-quack-android/blob/main/LICENSE
*/

module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
3 changes: 1 addition & 2 deletions website/docs/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@
## Tech Stacks

- GitHub Actions
- Android Studio Lint
- Jetpack Compose UI (for Android)
- Jetpack Compose Runtime
- Kotlin Symbol Processing
- Kotlin Compiler Plugin
- Gradle Plugin
- Gradle Plugin
File renamed without changes.
7 changes: 3 additions & 4 deletions website/docs/contributing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Contributing

# How to contribute

꽥꽥 프로젝트에 관심을 갖고 기여해 주셔서 감사합니다.
꽥꽥 프로젝트에 관심 갖고 기여해 주셔서 감사합니다.
따라야 할 몇 가지 작은 규칙이 있습니다.

## Preparing a pull request for review
Expand All @@ -18,7 +18,7 @@ sidebar_label: Contributing
코드 스타일도 정돈돼야 합니다.

```bash
./gradlew ktlintFormat
./gradlew ktlintCheck
./gradlew detekt
```

Expand All @@ -30,5 +30,4 @@ sidebar_label: Contributing

## Code reviews

덕키 멤버의 PR을 포함한 모든 PR은 검토가 필요합니다.
검토는 최대 일주일 내로 진행됩니다.
덕키 멤버의 PR을 포함한 모든 PR은 검토가 필요합니다. 검토는 최대 일주일 내로 진행됩니다.
31 changes: 7 additions & 24 deletions website/docs/development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,18 @@

```kotlin
implementation(platform("team.duckie.quackquack.bom:bom:${version}"))

implementation("team.duckie.quackquack.runtime:runtime")
implementation("team.duckie.quackquack.material:material")
implementation("team.duckie.quackquack.animation:animation")
implementation("team.duckie.quackquack.ui:ui")

// "kotlinCompilerPluginClasspath"("team.duckie.quackquack.sugar:sugar-processor:${version}")
implementation("team.duckie.quackquack.sugar:sugar-material")

lintChecks("team.duckie.quackquack.aide:aide:${version}")
implementation("team.duckie.quackquack.aide:aide-annotation")
ksp("team.duckie.quackquack.aide:aide-processor:${version}")

implementation("team.duckie.quackquack.casa:casa-ui")
implementation("team.duckie.quackquack.casa:casa-annotation")
implementation("team.duckie.quackquack.casa:casa-material")
// ksp("team.duckie.quackquack.casa:casa-processor:${version}")

implementation("team.duckie.quackquack.util:util")
```

이용 가능한 모든 아티팩트는 [maven central repository](https://central.sonatype.com/search?q=team.duckie.quackquack)에서 확인하실 수 있습니다.

#### Snapshot

개발 중 버전은 [Sonatype의 snapshot 저장소](https://s01.oss.sonatype.org/content/repositories/snapshots/team/duckie/quackquack/)에 배포됩니다.
개발 중 버전은 [snapshot 저장소](https://s01.oss.sonatype.org/content/repositories/snapshots/team/duckie/quackquack/)에 배포됩니다.

```kotlin
repositories {
maven("https://s01.oss.sonatype.org/content/repositories/snapshots/") {
mavenContent { snapshotsOnly() }
}
maven("https://s01.oss.sonatype.org/content/repositories/snapshots/") {
mavenContent { snapshotsOnly() }
}
}
```
```
4 changes: 2 additions & 2 deletions website/docs/guides/casa/annotation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_label: annotation
---

# casa-annotation
# casa-annotation

... 작성 중

Expand All @@ -12,4 +12,4 @@ sidebar_label: annotation

```kotlin
implementation("team.duckie.quackquack.casa:casa-annotation:${version}")
```
```
4 changes: 2 additions & 2 deletions website/docs/guides/casa/material.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ sidebar_label: material
# casa-material

... 작성 중

본 모듈은 안드로이드 의존성이 있는 [casa-processor](processor.mdx) 메타데이터 클래스를 제공합니다.

## Download ![](https://img.shields.io/maven-central/v/team.duckie.quackquack.casa/casa-material?style=flat-square) {#download}

```kotlin
implementation("team.duckie.quackquack.casa:casa-material:${version}")
```
```
159 changes: 0 additions & 159 deletions website/docs/guides/documentation-style.mdx

This file was deleted.

Loading

0 comments on commit d299d44

Please sign in to comment.