Move diagnostics list to manual

soutaro · Dec 2, 2024 · 9745527 · 9745527
1 parent 9680b74
commit 9745527
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 5 deletions.
diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
@@ -45,5 +45,5 @@ jobs:
         gem install bundler
         bin/setup
         bundle exec ruby bin/generate-diagnostics-docs.rb
-        git diff --exit-code HEAD -- guides/src/diagnostics
+        git diff --exit-code HEAD -- manual
 
diff --git a/bin/generate-diagnostics-docs.rb b/bin/generate-diagnostics-docs.rb
@@ -99,11 +99,11 @@ def self.visit_file(path, &block)
 end
 
 diagnostic_dir = Pathname(__dir__ || raise) + "../sig/steep/diagnostic"
-output_dir = Pathname(__dir__ || raise) + "../guides/src/diagnostics"
+output_dir = Pathname(__dir__ || raise) + "../manual"
 
 RubyDiagnosticsVisitor.visit_file(diagnostic_dir + "ruby.rbs") do |visitor|
-  STDERR.puts ">> Writing #{output_dir + "ruby.md"}..."
-  (output_dir + "ruby.md").open("w") do |io|
+  STDERR.puts ">> Writing #{output_dir + "ruby-diagnostics.md"}..."
+  (output_dir + "ruby-diagnostics.md").open("w") do |io|
     io.puts "# Ruby Code Diagnostics"
     io.puts
     visitor.format_templates(io)

diff --git a/guides/README.md b/guides/README.md
@@ -3,4 +3,3 @@
 * [Getting Started with Steep in 5 minutes](src/getting-started/getting-started.md)
 * [Using RBS from gem_rbs_collection](src/gem-rbs-collection/gem-rbs-collection.md)
 * [`nil` and Optional types](src/nil-optional/nil-optional.md)
-* [Diagnostics for Ruby code](src/diagnostics/ruby.md)
diff --git a/guides/src/diagnostics/ruby.md → manual/ruby-diagnostics.md b/guides/src/diagnostics/ruby.md → manual/ruby-diagnostics.md