Skip to content

Commit 6f973e1

Browse files
committed
Update documentation admonitions
1 parent 009ff0c commit 6f973e1

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

src/content/docs/docs/index.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ title: Creator Guide
1414

1515
Welcome, Developer! This guide will provide an overview of the App Fair development, release, and maintenance process. If you are already a mobile app developer, some of these sections will be review – but we encourage to read thoroughly regardless. The App Fair is a unique method of app development, and even if you have already shipped apps for the iPhone or Android (or both), many of the concepts presented here will be novel.
1616

17+
:::note[Work in Progress]
1718
The document is currently a **draft** of the creator guide. Many sections are still works in progress. Please post questions and feedback on the [App Fair discussion forums](https://github.com/orgs/appfair/discussions).
18-
{: class="callout error"}
19+
:::
1920

2021
### About the App Fair Project {#about-app-fair}
2122

@@ -73,15 +74,17 @@ In order to develop an app for the App Fair, you need to have a macOS developmen
7374

7475
Your app needs to have a distinctive and unique name that is not the name of any other app in the App Fair, Apple App Store, or Google Play Store.
7576

77+
:::caution[Naming]
7678
It can be difficult to conclusively verify ahead of time that a name is available because there are many "name-squatters" on the commercial app stores. Don't get too attached to your original idea, unless you are somehow quite certain that it is totally unique. It is easy to change the name of an app before publication, so our advice is to not spend too much time picking a name up front, since you might need to change it later anyway.
77-
{: class="callout error"}
79+
:::
7880

7981
### Make a proposal {#proposal}
8082

8183
When you have an idea for an app, you may want to propose it on the [App Fair discussion forums](https://github.com/orgs/appfair/discussions). This will give the community the opportunity to provide feedback on the idea, as well as make an assessment about whether the app will be suitable for distribution through the Ap Fair.
8284

85+
:::note[Proposals]
8386
Creating a proposal is optional, but it is a good way to get community feedback on your idea before you invest effort in building something that might not fit well with the App Fair's mission or needs.
84-
{: class="callout warning"}
87+
:::
8588

8689
### Creating an organization and repository {#new-org-repo}
8790

@@ -113,9 +116,9 @@ git push -u origin main
113116

114117
Your repository is now created and initialized with a new, valid (albeit vanilla and uninteresting) App Fair app.
115118

119+
:::caution[GitHub CI Required]
116120
In addition to creating the repository, the app is also set up with a GitHub continuous integration workflow that will build your app every time you push a commit or create a Pull Request. This action is a critical part of the App Fair process, and should not be disabled.
117-
{: class="callout warning"}
118-
121+
:::
119122

120123
## Developing {#developing}
121124

0 commit comments

Comments
 (0)