diff --git a/Changes.md b/Community/Changes.md similarity index 100% rename from Changes.md rename to Community/Changes.md diff --git a/Credits.md b/Community/Credits.md similarity index 100% rename from Credits.md rename to Community/Credits.md diff --git a/Nightly-Builds.md b/Community/Nightly-Builds.md similarity index 100% rename from Nightly-Builds.md rename to Community/Nightly-Builds.md diff --git a/Opportunities.md b/Community/Opportunities.md similarity index 100% rename from Opportunities.md rename to Community/Opportunities.md diff --git a/Community/_Sidebar.md b/Community/_Sidebar.md new file mode 100644 index 0000000..4d30db0 --- /dev/null +++ b/Community/_Sidebar.md @@ -0,0 +1,17 @@ +* [[Home]] - Overview of sbt +* [[Getting Started Guide|Getting Started Welcome]] - START HERE +* [[FAQ]] - Questions, answered. +* [[Index]] - Find types, values, and methods +* [[Community]] - source, forums, releases + * [[Change history|Changes]] + * [[Credits]] + * [[License|https://github.com/harrah/xsbt/blob/0.11/LICENSE]] + * [[Source code (github)|https://github.com/harrah/xsbt/tree/0.11]] + * [[Source code (SXR)|http://harrah.github.com/xsbt/latest/sxr/index.html]] + * [[API Documentation|http://harrah.github.com/xsbt/latest/api/index.html]] + * [[Places to help|Opportunities]] + * [[Nightly Builds]] + * [[Plugins list|sbt-0.10-plugins-list]] +* [[Examples]] +* [[Detailed Topics]] - deep dive docs +* [[Extending sbt|Extending]] - internals docs diff --git a/sbt-0.10-plugins-list.md b/Community/sbt-0.10-plugins-list.md similarity index 100% rename from sbt-0.10-plugins-list.md rename to Community/sbt-0.10-plugins-list.md diff --git a/Artifacts.md b/Detailed-Topics/Artifacts.md similarity index 100% rename from Artifacts.md rename to Detailed-Topics/Artifacts.md diff --git a/Best-Practices.md b/Detailed-Topics/Best-Practices.md similarity index 100% rename from Best-Practices.md rename to Detailed-Topics/Best-Practices.md diff --git a/Classpaths.md b/Detailed-Topics/Classpaths.md similarity index 100% rename from Classpaths.md rename to Detailed-Topics/Classpaths.md diff --git a/Compiler-Plugins.md b/Detailed-Topics/Compiler-Plugins.md similarity index 100% rename from Compiler-Plugins.md rename to Detailed-Topics/Compiler-Plugins.md diff --git a/Console-Project.md b/Detailed-Topics/Console-Project.md similarity index 100% rename from Console-Project.md rename to Detailed-Topics/Console-Project.md diff --git a/Cross-Build.md b/Detailed-Topics/Cross-Build.md similarity index 100% rename from Cross-Build.md rename to Detailed-Topics/Cross-Build.md diff --git a/Forking.md b/Detailed-Topics/Forking.md similarity index 100% rename from Forking.md rename to Detailed-Topics/Forking.md diff --git a/Global-Settings.md b/Detailed-Topics/Global-Settings.md similarity index 100% rename from Global-Settings.md rename to Detailed-Topics/Global-Settings.md diff --git a/Inspecting-Settings.md b/Detailed-Topics/Inspecting-Settings.md similarity index 100% rename from Inspecting-Settings.md rename to Detailed-Topics/Inspecting-Settings.md diff --git a/Java-Sources.md b/Detailed-Topics/Java-Sources.md similarity index 100% rename from Java-Sources.md rename to Detailed-Topics/Java-Sources.md diff --git a/Launcher.md b/Detailed-Topics/Launcher.md similarity index 100% rename from Launcher.md rename to Detailed-Topics/Launcher.md diff --git a/Library-Management.md b/Detailed-Topics/Library-Management.md similarity index 100% rename from Library-Management.md rename to Detailed-Topics/Library-Management.md diff --git a/Local-Scala.md b/Detailed-Topics/Local-Scala.md similarity index 100% rename from Local-Scala.md rename to Detailed-Topics/Local-Scala.md diff --git a/Mapping-Files.md b/Detailed-Topics/Mapping-Files.md similarity index 100% rename from Mapping-Files.md rename to Detailed-Topics/Mapping-Files.md diff --git a/Migrating-from-SBT-0.7.x-to-0.10.x.md b/Detailed-Topics/Migrating-from-SBT-0.7.x-to-0.10.x.md similarity index 100% rename from Migrating-from-SBT-0.7.x-to-0.10.x.md rename to Detailed-Topics/Migrating-from-SBT-0.7.x-to-0.10.x.md diff --git a/Parsing-Input.md b/Detailed-Topics/Parsing-Input.md similarity index 100% rename from Parsing-Input.md rename to Detailed-Topics/Parsing-Input.md diff --git a/Paths.md b/Detailed-Topics/Paths.md similarity index 100% rename from Paths.md rename to Detailed-Topics/Paths.md diff --git a/Process.md b/Detailed-Topics/Process.md similarity index 100% rename from Process.md rename to Detailed-Topics/Process.md diff --git a/Publishing.md b/Detailed-Topics/Publishing.md similarity index 100% rename from Publishing.md rename to Detailed-Topics/Publishing.md diff --git a/Resolvers.md b/Detailed-Topics/Resolvers.md similarity index 100% rename from Resolvers.md rename to Detailed-Topics/Resolvers.md diff --git a/Running-Project-Code.md b/Detailed-Topics/Running-Project-Code.md similarity index 100% rename from Running-Project-Code.md rename to Detailed-Topics/Running-Project-Code.md diff --git a/Scripts.md b/Detailed-Topics/Scripts.md similarity index 100% rename from Scripts.md rename to Detailed-Topics/Scripts.md diff --git a/Setup-Notes.md b/Detailed-Topics/Setup-Notes.md similarity index 100% rename from Setup-Notes.md rename to Detailed-Topics/Setup-Notes.md diff --git a/TaskInputs.md b/Detailed-Topics/TaskInputs.md similarity index 100% rename from TaskInputs.md rename to Detailed-Topics/TaskInputs.md diff --git a/Tasks.md b/Detailed-Topics/Tasks.md similarity index 100% rename from Tasks.md rename to Detailed-Topics/Tasks.md diff --git a/Testing.md b/Detailed-Topics/Testing.md similarity index 100% rename from Testing.md rename to Detailed-Topics/Testing.md diff --git a/Triggered-Execution.md b/Detailed-Topics/Triggered-Execution.md similarity index 100% rename from Triggered-Execution.md rename to Detailed-Topics/Triggered-Execution.md diff --git a/Update-Report.md b/Detailed-Topics/Update-Report.md similarity index 100% rename from Update-Report.md rename to Detailed-Topics/Update-Report.md diff --git a/Detailed-Topics/_Sidebar.md b/Detailed-Topics/_Sidebar.md new file mode 100644 index 0000000..0e340a8 --- /dev/null +++ b/Detailed-Topics/_Sidebar.md @@ -0,0 +1,36 @@ +* [[Home]] - Overview of sbt +* [[Getting Started Guide|Getting Started Welcome]] - START HERE +* [[FAQ]] - Questions, answered. +* [[Index]] - Find types, values, and methods +* [[Community]] - source, forums, releases +* [[Examples]] +* [[Detailed Topics]] - deep dive docs + * [[Artifacts]] what to publish + * [[Best Practices]] + * [[Classpaths]] + * [[Compiler Plugins]] + * [[Console Project]] + * [[Cross Build]] + * [[Forking]] + * [[Global Settings]] + * [[Inspecting Settings]] + * [[Java Sources]] + * [[Launcher]] + * [[Library Management]] + * [[Local Scala]] + * [[Mapping Files]] + * [[Migrating to 0.10+|Migrating from SBT 0.7.x to 0.10.x]] + * [[Parsing Input]] + * [[Paths]] + * [[Process]] + * [[Publishing]] + * [[Resolvers]] + * [[Running Project Code]] + * [[Scripts]] + * [[Setup Notes]] + * [[Tasks]] + * [[TaskInputs]] + * [[Testing]] + * [[Triggered Execution]] + * [[Update Report]] +* [[Extending sbt|Extending]] - internals docs diff --git a/Advanced-Command-Example.md b/Examples/Advanced-Command-Example.md similarity index 100% rename from Advanced-Command-Example.md rename to Examples/Advanced-Command-Example.md diff --git a/Advanced-Configurations-Example.md b/Examples/Advanced-Configurations-Example.md similarity index 100% rename from Advanced-Configurations-Example.md rename to Examples/Advanced-Configurations-Example.md diff --git a/Full-Configuration-Example.md b/Examples/Full-Configuration-Example.md similarity index 100% rename from Full-Configuration-Example.md rename to Examples/Full-Configuration-Example.md diff --git a/Quick-Configuration-Examples.md b/Examples/Quick-Configuration-Examples.md similarity index 100% rename from Quick-Configuration-Examples.md rename to Examples/Quick-Configuration-Examples.md diff --git a/Examples/_Sidebar.md b/Examples/_Sidebar.md new file mode 100644 index 0000000..c78c88a --- /dev/null +++ b/Examples/_Sidebar.md @@ -0,0 +1,12 @@ +* [[Home]] - Overview of sbt +* [[Getting Started Guide|Getting Started Welcome]] - START HERE +* [[FAQ]] - Questions, answered. +* [[Index]] - Find types, values, and methods +* [[Community]] - source, forums, releases +* [[Examples]] + * [[.scala examples|Full Configuration Example]] + * [[.sbt examples|Quick Configuration Examples]] + * [[Advanced Command Example]] + * [[Advanced Configurations Example]] +* [[Detailed Topics]] - deep dive docs +* [[Extending sbt|Extending]] - internals docs diff --git a/Build-State.md b/Extending/Build-State.md similarity index 100% rename from Build-State.md rename to Extending/Build-State.md diff --git a/Commands.md b/Extending/Commands.md similarity index 100% rename from Commands.md rename to Extending/Commands.md diff --git a/Input-Tasks.md b/Extending/Input-Tasks.md similarity index 100% rename from Input-Tasks.md rename to Extending/Input-Tasks.md diff --git a/Plugins-Best-Practices.md b/Extending/Plugins-Best-Practices.md similarity index 100% rename from Plugins-Best-Practices.md rename to Extending/Plugins-Best-Practices.md diff --git a/Plugins.md b/Extending/Plugins.md similarity index 100% rename from Plugins.md rename to Extending/Plugins.md diff --git a/Settings-Core.md b/Extending/Settings-Core.md similarity index 100% rename from Settings-Core.md rename to Extending/Settings-Core.md diff --git a/Extending/_Sidebar.md b/Extending/_Sidebar.md new file mode 100644 index 0000000..0169fcc --- /dev/null +++ b/Extending/_Sidebar.md @@ -0,0 +1,15 @@ +* [[Home]] - Overview of sbt +* [[Getting Started Guide|Getting Started Welcome]] - START HERE +* [[FAQ]] - Questions, answered. +* [[Index]] - Find types, values, and methods +* [[Community]] - source, forums, releases +* [[Examples]] +* [[Detailed Topics]] - deep dive docs +* [[Extending sbt|Extending]] - internals docs + * [[API Documentation|http://harrah.github.com/xsbt/latest/api/index.html]] + * [[Commands]] + * [[Input Tasks]] + * [[Plugins Best Practices]] + * [[Plugins]] + * [[Settings engine|Settings Core]] + * [[State objects|Build State]] diff --git a/Getting-Started/_Sidebar.md b/Getting-Started/_Sidebar.md index da4b855..ded1fd9 100644 --- a/Getting-Started/_Sidebar.md +++ b/Getting-Started/_Sidebar.md @@ -1,5 +1,5 @@ * [[Home]] - Overview of sbt -* [[Getting Started Guide|Getting Started Welcome]] +* [[Getting Started Guide|Getting Started Welcome]] - START HERE * [[Setup|Getting Started Setup]] - Install sbt * [[Hello, World|Getting Started Hello]] - Create a simple project * [[Directory Layout|Getting Started Directories]] - Basic project layout @@ -13,67 +13,9 @@ * [[Multi-Project Builds|Getting Started Multi-Project]] - Adding sub-projects to the build * [[Custom Settings and Tasks|Getting Started Custom Settings]] - Intro to extending sbt * [[Summary|Getting Started Summary]] - What you should know now -* Help - * [[Migrating from sbt 0.7.x to 0.10.x]] - * [[Index]] - Look up common types, values, and methods - * [[FAQ]] -* Usage - * [[Triggered Execution]] - * [[Cross Build]] - * [[Console Project]] - * [[Inspecting Settings]] - * [[Running Project Code]] - * [[sbt Plugins List|sbt 0.10 Plugins List]] -* Configuration - * [[Settings]] - * [[Basic Configuration]] - * [[Full Configuration]] - * [[Global Settings]] - * Examples - * [[Quick|Quick Configuration Examples]] - * [[Full|Full Configuration Example]] - * [[Advanced Command Example]] - * [[Advanced Configurations Example]] - * Managed Dependencies - * [[Basic|Library Management]] - * [[Configurations]] - * [[Defining Repositories|Resolvers]] - * [[Publishing]] - * [[Artifacts]] - * [[Update Report]] - * [[Testing]] - * [[Forking]] - * [[Java Sources]] - * [[Local Scala]] - * Using [[Compiler Plugins]] - * [[Plugins]] - Extending sbt -* Tasks and Commands - * Basic Constructs - * [[Task|Tasks]] - * [[Input Tasks]] - * [[Commands]] - * [[Common Tasks]] - * [[Parsing Input]] - * [[Build State]] - * Paths and I/O - * [[Paths]] - * [[Classpaths, sources, and resources|Classpaths]] - * [[Mapping Files]] - * [[External Processes|Process]] - * [[Specialized Tasks|Specialized]] -* Guidelines - * [[Task Inputs/Dependencies|TaskInputs]] - How to connect tasks together - * [[General Best Practices|Best Practices]] - * [[Plugin Best Practices|Plugins Best Practices]] -* Other Modes - * [[Launcher]] - Using the launcher for booting Scala applications - * [[Scripts]] and REPL with dependencies -* Project Information - * [[Credits]] - * [[Changes]] - * [[Source code|https://github.com/harrah/xsbt/tree/0.11]] - * [[License|https://github.com/harrah/xsbt/blob/0.11/LICENSE]] - * [[API Documentation|http://harrah.github.com/xsbt/latest/api/index.html]] - * [[SXR Documentation|http://harrah.github.com/xsbt/latest/sxr/index.html]] - * [[Opportunities]] - * [[Nightly Builds]] +* [[FAQ]] - Questions, answered. +* [[Index]] - Find types, values, and methods +* [[Community]] - source, forums, releases +* [[Examples]] +* [[Detailed Topics]] - deep dive docs +* [[Extending sbt|Extending]] - internals docs diff --git a/_Sidebar.md b/_Sidebar.md index 6cd8164..a2a9cc7 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -1,66 +1,8 @@ * [[Home]] - Overview of sbt * [[Getting Started Guide|Getting Started Welcome]] - START HERE -* Help - * [[Migrating from sbt 0.7.x to 0.10.x]] - * [[Index]] - Look up common types, values, and methods - * [[FAQ]] -* Usage - * [[Triggered Execution]] - * [[Cross Build]] - * [[Console Project]] - * [[Inspecting Settings]] - * [[Running Project Code]] - * [[sbt Plugins List|sbt 0.10 Plugins List]] -* Configuration - * [[Settings]] - * [[Basic Configuration]] - * [[Full Configuration]] - * [[Global Settings]] - * Examples - * [[Quick|Quick Configuration Examples]] - * [[Full|Full Configuration Example]] - * [[Advanced Command Example]] - * [[Advanced Configurations Example]] - * Managed Dependencies - * [[Basic|Library Management]] - * [[Configurations]] - * [[Defining Repositories|Resolvers]] - * [[Publishing]] - * [[Artifacts]] - * [[Update Report]] - * [[Testing]] - * [[Forking]] - * [[Java Sources]] - * [[Local Scala]] - * Using [[Compiler Plugins]] - * [[Plugins]] - Extending sbt -* Tasks and Commands - * Basic Constructs - * [[Task|Tasks]] - * [[Input Tasks]] - * [[Commands]] - * [[Common Tasks]] - * [[Parsing Input]] - * [[Build State]] - * Paths and I/O - * [[Paths]] - * [[Classpaths, sources, and resources|Classpaths]] - * [[Mapping Files]] - * [[External Processes|Process]] - * [[Specialized Tasks|Specialized]] -* Guidelines - * [[Task Inputs/Dependencies|TaskInputs]] - How to connect tasks together - * [[General Best Practices|Best Practices]] - * [[Plugin Best Practices|Plugins Best Practices]] -* Other Modes - * [[Launcher]] - Using the launcher for booting Scala applications - * [[Scripts]] and REPL with dependencies -* Project Information - * [[Credits]] - * [[Changes]] - * [[Source code|https://github.com/harrah/xsbt/tree/0.11]] - * [[License|https://github.com/harrah/xsbt/blob/0.11/LICENSE]] - * [[API Documentation|http://harrah.github.com/xsbt/latest/api/index.html]] - * [[SXR Documentation|http://harrah.github.com/xsbt/latest/sxr/index.html]] - * [[Opportunities]] - * [[Nightly Builds]] +* [[FAQ]] - Questions, answered. +* [[Index]] - Find types, values, and methods +* [[Community]] - source, forums, releases +* [[Examples]] +* [[Detailed Topics]] - deep dive docs +* [[Extending sbt|Extending]] - internals docs