diff --git a/.vscode/tasks.json b/.vscode/tasks.json index ecd55ef5..5bc26e3d 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -47,12 +47,27 @@ "problemMatcher": [], "group": "none", "label": "Dart: doc", - "detail": "View the documentation.", + "detail": "Generate the documentation.", "icon": { "color": "terminal.ansiGreen", "id": "book" } }, + { + "type": "dart", + "command": "dart", + "cwd": ".", + "args": ["run", "dhttpd", "--path", "doc/api"], + "problemMatcher": [], + "group": "none", + "label": "Dart: docs via dhttpd", + "detail": "View the generateed documentation.", + "isBackground": true, + "icon": { + "color": "terminal.ansiGreen", + "id": "server" + } + }, { "type": "flutter", "command": "flutter", diff --git a/README.md b/README.md index afc19b35..5603f73e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

- Pirate Code 3.0 - An App for the Pattonville School District + Pirate Wallet - An App for the Pattonville School District

@@ -25,18 +25,14 @@ [![spelling][ci_spell_badge]][ci_spell_link] [![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link] -A (Very Good) ~~new~~ Flutter project initially generated by the by the [Very Good CLI][very_good_cli_link] 🤖 - ## More Information -We don't believe that READMEs should be a 15 Terabyte[^1] file, so we broke it up. +We don't believe that a README should be an extremely large file mostly just full of contribution information, so we broke it up. -- For more information about this project, and how to get started, look at our [wiki](https://github.com/PSDTools/app/wiki). +- For more information about this project, and how to get started, look at the [`doc/`][doc] folder. - For more information about us, check out our [organization readme](https://github.com/PSDTools#welcome-to-the-team-). Finally, - For more information about our progress, you could take a peek at our meta-project board. -[^1]: Not that ours was before... but it was getting on the larger side. - [ci_dart_badge]: https://github.com/PSDTools/app/actions/workflows/dart.yaml/badge.svg?branch=main [ci_dart_link]: https://github.com/PSDTools/app/actions/workflows/dart.yaml [ci_spell_badge]: https://github.com/PSDTools/app/actions/workflows/markdown.yaml/badge.svg?branch=main @@ -44,6 +40,6 @@ We don't believe that READMEs should be a 15 Terabyte[^1] file, so we broke it u [coverage_badge]: https://img.shields.io/badge/coverage-30%25-CB2431.svg [deploys_badge]: https://api.netlify.com/api/v1/badges/25b0c44e-21b7-423c-a914-32aa4b23b708/deploy-status [deploys_link]: https://app.netlify.com/sites/pattonville-wallet/deploys +[doc]: ./doc/ [very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg [very_good_analysis_link]: https://pub.dev/packages/very_good_analysis -[very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli diff --git a/dartdoc_options.yaml b/dartdoc_options.yaml index 4dc0de8b..49e62243 100644 --- a/dartdoc_options.yaml +++ b/dartdoc_options.yaml @@ -9,20 +9,26 @@ dartdoc: "Testing": markdown: doc/tests.md name: Testing, Testing, 1, 2, 3 - Translations: + "Translations": markdown: doc/translations.md name: Translations - Server: + "Server": markdown: doc/docker.md name: Appwrite + "Providers": + markdown: doc/providers-diagram.md + name: Providers Diagram categoryOrder: - "Getting Started" - "Testing" - "Translations" - - "C4Diagram" - "Server" + - "C4Diagram" + - "Providers" showUndocumentedCategories: true - includeExternal: ["test/helpers/*.dart"] + includeExternal: + - test/helpers/pump_app.dart + - test/helpers/riverpod.dart linkToSource: uriTemplate: "https://github.com/psdtools/app/blob/main/%f%#L%l%" root: "." diff --git a/doc/docker.md b/doc/docker.md index b8681821..999f5cd4 100644 --- a/doc/docker.md +++ b/doc/docker.md @@ -10,10 +10,10 @@ You **must** use the default settings in order to allow binding to `localhost:80 ## Install Appwrite Server To install Appwrite using Docker, run the following command, -substituting `1.4.1` with the newest Appwrite Server version supported by the Appwrite SDK currently in use: +substituting `1.4.9` with the newest Appwrite Server version supported by the Appwrite SDK currently in use: ```sh -docker run -it --rm --volume /var/run/docker.sock:/var/run/docker.sock --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw --entrypoint="install" appwrite/appwrite:1.4.1 +docker run -it --rm --volume /var/run/docker.sock:/var/run/docker.sock --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw --entrypoint="install" appwrite/appwrite:1.4.9 ``` ## Create a new Appwrite Project diff --git a/lib/main.dart b/lib/main.dart index a83203d0..ebe204db 100644 --- a/lib/main.dart +++ b/lib/main.dart @@ -2,6 +2,7 @@ /// /// {@category Getting Started} /// {@category C4Diagram} +/// {@category Providers} library; import "app/app.dart"; diff --git a/lib/utils/api.dart b/lib/utils/api.dart index 424a155a..687694cd 100644 --- a/lib/utils/api.dart +++ b/lib/utils/api.dart @@ -1,6 +1,6 @@ /// This library contains utilities for the Appwrite API. /// -/// {@Category Server} +/// {@category Server} library; // cSpell:ignore realtime