Consolidate formatting pages (#5387)

We have different issues open tracking other improvements to the page. Fixes #5091 --------- Co-authored-by: Marya <[email protected]>
dart-lang · Dec 4, 2023 · 96d527b · 96d527b
1 parent d2f69c6
commit 96d527b
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 55 deletions.
diff --git a/firebase.json b/firebase.json
@@ -192,6 +192,7 @@
       { "source": "/guides/language/effective-dart", "destination": "/effective-dart", "type": 301 },
       { "source": "/guides/language/effective-dart/:page*", "destination": "/effective-dart/:page*", "type": 301 },
       { "source": "/guides/language/extension-methods", "destination": "/language/extension-methods", "type": 301 },
+      { "source": "/guides/language/formatting", "destination": "/tools/dart-format", "type": 301 },
       { "source": "/guides/language/library-tour", "destination": "/guides/libraries/library-tour", "type": 301 },
       { "source": "/guides/language/sound-dart", "destination": "/language/type-system", "type": 301 },
       { "source": "/guides/language/sound-faq", "destination": "/language/type-system", "type": 301 },

diff --git a/src/_data/side-nav.yml b/src/_data/side-nav.yml
@@ -307,12 +307,6 @@
           permalink: /tools/build_runner
         - title: webdev
           permalink: /tools/webdev
-  - title: Managing source code
-    children:
-      - title: Formatting code
-        permalink: /guides/language/formatting
-      - title: What not to commit
-        permalink: /guides/libraries/private-files
   - title: Static analysis
     children:
       - title: Customizing static analysis
@@ -331,6 +325,8 @@
         permalink: /guides/testing
       - title: Debugging web apps
         permalink: /web/debugging
+  - title: What not to commit
+    permalink: /guides/libraries/private-files
 
 - title: Resources
   expanded: false

diff --git a/src/guides/language/formatting.md b/src/guides/language/formatting.md
diff --git a/src/tools/dart-format.md b/src/tools/dart-format.md
@@ -60,15 +60,14 @@ use the `dart help` command or see the documentation for the
 $ dart help format
 ```
 
-{% comment %}
-[PENDING: Add info on commonly used options.]
-
-[PENDING: Advocate using this! Perhaps steal the first paragraph from
-dart_style's readme:
+{{site.alert.tip}}
+  To avoid making changes that might be unsafe,
+  `dart format` only affects whitespace.
+
+  There's a lot more to writing readable and
+  consistent code than just whitespace, though.
+  To learn more about best practices for writing and styling Dart code,
+  check out the [Dart style guide][].
+{{site.alert.end}}
 
-The dart_style package defines an automatic, opinionated formatter
-for Dart code. It replaces the whitespace in your program with what
-it deems to be the best formatting for it. Resulting code should
-follow the Dart style guide and, more importantly, should look nice
-to most human readers, most of the time.]
-{% endcomment %}
+[Dart style guide]: /effective-dart/style