move the guides back into the main layout of the docs directory

guides/README.mdx → docs/guides/README.mdx

@@ -1,5 +1,5 @@
 ---
-title: Guides
+title: How-To Guides
 description: here you will find really useful guides
 hide_table_of_contents: true
 sidebar_position: 0

docs/guides/_category_.json

@@ -0,0 +1,4 @@
+{
+    "position": 35,
+    "collapsible": false
+}

guides/conventions/upgrading-contracts.mdx → docs/guides/conventions/upgrading-contracts.mdx

@@ -81,7 +81,7 @@ pub fn upgrade(e: Env, new_wasm_hash: BytesN<32>) {
 The `update_current_contract_wasm` host function will also emit a `SYSTEM` contract [event] that contains the old and new wasm reference, allowing downstream users to be notified when a contract they use is updated. The event structure will have `topics = ["executable_update", old_executable: ContractExecutable, old_executable: ContractExecutable]` and `data = []`.
 
 [here]: https://docs.rs/soroban-sdk/20.0.0-rc2/soroban_sdk/struct.Env.html#method.update_current_contract_wasm
-[event]: ../../docs/soroban-internals/events#event-types
+[event]: ../../soroban-internals/events.mdx#event-types
 
 ## Tests
 
@@ -286,4 +286,4 @@ Now that the contract was upgraded, you'll see a new version.
 2
 ```
 
-[`soroban-cli`]: ../../docs/getting-started/setup#install-the-soroban-cli
+[`soroban-cli`]: ../../getting-started/setup.mdx#install-the-soroban-cli

guides/events/publish.mdx → docs/guides/events/publish.mdx

@@ -47,4 +47,4 @@ pub fn transfer(env: Env, from: Address, to: Address, amount: i128) {
 }
 ```
 
-[token interface]: ../../docs/tokens/token-interface
+[token interface]: ../../tokens/token-interface.mdx

docs/soroban-internals/contract-lifecycle.mdx

@@ -63,4 +63,4 @@ TBD: expand this section.
 
 ## Upgrading contracts
 
-See the [Upgrading Contracts](../../guides/conventions/upgrading-contracts) page for details on this.
+See the [Upgrading Contracts](../guides/conventions/upgrading-contracts.mdx) page for details on this.

docusaurus.config.js

@@ -22,18 +22,18 @@ const config = {
   },
   plugins: [
     "docusaurus-plugin-sass",
-    [
-      '@docusaurus/plugin-content-docs',
-      {
-        id: 'guides',
-        path: 'guides',
-        routeBasePath: 'guides',
-        sidebarPath: require.resolve('./sidebarsGuides.js'),
-        sidebarItemsGenerator: require('./src/sidebar-generator'),
-        editUrl: "https://github.com/stellar/soroban-docs/tree/main/",
-        showLastUpdateTime: true,
-      },
-    ],
+    // [
+    //   '@docusaurus/plugin-content-docs',
+    //   {
+    //     id: 'guides',
+    //     path: 'guides',
+    //     routeBasePath: 'guides',
+    //     sidebarPath: require.resolve('./sidebarsGuides.js'),
+    //     sidebarItemsGenerator: require('./src/sidebar-generator'),
+    //     editUrl: "https://github.com/stellar/soroban-docs/tree/main/",
+    //     showLastUpdateTime: true,
+    //   },
+    // ],
     [
       '@docusaurus/plugin-content-docs',
       {
@@ -121,11 +121,11 @@ const config = {
             label: 'Dapps',
             position: 'left'
           },
-          {
-            to: '/guides',
-            label: 'Guides',
-            position: 'left'
-          },
+          // {
+          //   to: '/guides',
+          //   label: 'Guides',
+          //   position: 'left'
+          // },
           {
             href: 'https://github.com/stellar/rs-soroban-sdk',
             label: 'GitHub',

src/sidebar-generator.js

@@ -5,14 +5,14 @@ module.exports = async ({ defaultSidebarItemsGenerator, ...args }) => {
 
     if (args.version.contentPath.endsWith('docs')) {
         /**
-         * Adds a custom class name to the "Tutorials" index page, which we then
-         * use in the `/src/css/custom.scss` file to hide the `<ul>` element
-         * that is contained within the item. The result is a single "Tutorials"
-         * page that contains the list of all the docs underneath it, while
-         * those items are not displayed in the sidebar.
+         * Adds a custom class name to the "Tutorials" and "How-To Guides" index
+         * pages, which we then use in the `/src/css/custom.scss` file to hide
+         * the `<ul>` element that is contained within the item. The result is a
+         * single "Tutorials/Guides" page that contains the list of all the docs
+         * underneath it, while those items are not displayed in the sidebar.
          */
         args.docs.map((doc) => {
-            if (doc.id === 'tutorials/README') {
+            if (doc.id === 'guides/README' || doc.id === 'tutorials/README') {
                 doc.frontMatter.sidebar_class_name = "sidebar-category-items-hidden"
             }
         })
@@ -25,9 +25,9 @@ module.exports = async ({ defaultSidebarItemsGenerator, ...args }) => {
          * sidebar class name does (above). For now, make sure to manually add
          * `hide_table_of_contents: true` to the front matter of each guide doc.
          */
-        args.docs.map((doc) =>
+        args.docs.map((doc) => {
             doc.frontMatter.hide_table_of_contents = true
-        )
+        })
     }
 
     const sidebarItems = await defaultSidebarItemsGenerator({ ...args })

src/theme/DocCardList/index.js

@@ -11,7 +11,7 @@ function DocCardListForCurrentSidebarCategory({className}) {
   const category = useCurrentSidebarCategory();
   return category.label === 'Tutorials'
     ? <FilterableDocCardList items={category.items} className={className} />
-    : category.label === 'Guides'
+    : category.label === 'How-To Guides'
     ? <GuidesDocList items={category.items} className={className} />
     : <DocCardList items={category.items} className={className} />;
 }

src/theme/DocItem/Footer/index.js

@@ -52,15 +52,15 @@ export default function DocItemFooter() {
   const canDisplayTagsRow = tags.length > 0;
   const canDisplayEditMetaRow = !!(editUrl || lastUpdatedAt || lastUpdatedBy);
   const canDisplayFooter = canDisplayTagsRow || canDisplayEditMetaRow;
-  const canDisplayDocCardsOnGuide = metadata.permalink.startsWith('/guides')
+  const canDisplayDocCardsOnGuide = metadata.permalink.startsWith('/docs/guides')
   if (!canDisplayFooter) {
     return null;
   }
   return (
     <>
       {canDisplayDocCardsOnGuide &&
-        <div className={clsx(metadata.permalink === '/guides/' ? 'margin-top--lg' : 'margin-top--xl')}>
-          {metadata.permalink !== '/guides/' && <h3>Guides in this category:</h3>}
+        <div className={clsx(metadata.permalink === '/docs/guides/' ? 'margin-top--lg' : 'margin-top--xl')}>
+          {metadata.permalink !== '/docs/guides/' && <h3>Guides in this category:</h3>}
           <DocCardList />
         </div>
       }