diff --git a/docs/collaboration/development-etiquette.md b/docs/collaboration/development-etiquette.md index 3bde403..1978b90 100644 --- a/docs/collaboration/development-etiquette.md +++ b/docs/collaboration/development-etiquette.md @@ -40,3 +40,11 @@ To avoid such situations, it is recommended for developers to perform a cursory should address common mistakes such as grammatical and spelling errors. See [common pull request issues](./common-pull-request-issues.md) for more information. + +## Submitting a Pull Request + + +
Flowchart for creating a pull request
+ +See [GitHub's documentation](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) +for more information on linking issues to pull request. \ No newline at end of file diff --git a/docs/style-guides/dart-flutter-style-guide.md b/docs/style-guides/dart-flutter-style-guide.md new file mode 100644 index 0000000..8303e67 --- /dev/null +++ b/docs/style-guides/dart-flutter-style-guide.md @@ -0,0 +1,9 @@ +--- +id: dart-flutter-style-guide +title: Dart/Flutter Style Guide +sidebar_label: Dart/Flutter Style Guide +--- + +We follow Effective Dart's [style guide](https://dart.dev/guides/language/effective-dart/style) and +[documentation style guide](https://dart.dev/guides/language/effective-dart/documentation). An exception to this is the +characters line limit. Instead of **_80_** characters, we adhere to a **_120_** characters line limit. diff --git a/docs/style-guides/java-style-guide.md b/docs/style-guides/java-style-guide.md new file mode 100644 index 0000000..e69de29 diff --git a/docusaurus.config.js b/docusaurus.config.js index 5dbd418..3ec09d9 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -23,14 +23,12 @@ const config = { ({ docs: { sidebarPath: require.resolve('./sidebars.js'), - // Please change this to your repo. - editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + editUrl: 'https://github.com/forus-labs/engineering-docs', }, blog: { showReadingTime: true, - // Please change this to your repo. editUrl: - 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + 'https://github.com/forus-labs/engineering-docs', }, theme: { customCss: require.resolve('./src/css/custom.css'), @@ -79,17 +77,9 @@ const config = { { title: 'Community', items: [ - { - label: 'Stack Overflow', - href: 'https://stackoverflow.com/questions/tagged/docusaurus', - }, - { - label: 'Discord', - href: 'https://discordapp.com/invite/docusaurus', - }, { label: 'Twitter', - href: 'https://twitter.com/docusaurus', + href: 'https://twitter.com/forus_labs', }, ], }, diff --git a/sidebars.js b/sidebars.js index ee609b2..294148f 100644 --- a/sidebars.js +++ b/sidebars.js @@ -37,10 +37,7 @@ module.exports = { type: 'category', label: 'Style Guides', items: [ -// 'manual-installation', -// 'manual-installation/android', -// 'manual-installation/ios', -// 'manual-installation/macos', + 'style-guides/dart-flutter-style-guide', { type: 'link', label: 'Technical Writing Guide', diff --git a/src/pages/index.js b/src/pages/index.js index 27c21e8..70640dd 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -16,8 +16,8 @@ function HomepageHeader() {