chore(v2): mention about docs home page in init templates (#2763)

* chore(v2): mention about docs home page in init templates

* use home page id for docs

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>

packages/docusaurus-init/templates/bootstrap/docusaurus.config.js

@@ -15,7 +15,7 @@ module.exports = {
       },
       links: [
         {
-          to: 'docs/doc1',
+          to: 'docs/',
           activeBasePath: 'docs',
           label: 'Docs',
           position: 'left',
@@ -53,7 +53,7 @@ module.exports = {
           items: [
             {
               label: 'Blog',
-              to: 'blog',
+              to: 'blog/',
             },
             {
               label: 'GitHub',
@@ -70,6 +70,8 @@ module.exports = {
       '@docusaurus/preset-bootstrap',
       {
         docs: {
+          // It is recommended to set document id as docs home page (`docs/` path).
+          homePageId: 'doc1',
           sidebarPath: require.resolve('./sidebars.js'),
           editUrl:
             'https://github.com/facebook/docusaurus/edit/master/website/',

packages/docusaurus-init/templates/bootstrap/src/pages/index.js

@@ -66,7 +66,7 @@ function Home() {
         <h1 className="hero__title">{siteConfig.title}</h1>
         <p className="hero__subtitle">{siteConfig.tagline}</p>
         <div className={styles.buttons}>
-          <Link to={useBaseUrl('docs/doc1')}>Get Started</Link>
+          <Link to={useBaseUrl('docs/')}>Get Started</Link>
         </div>
       </header>
       <main>

packages/docusaurus-init/templates/classic/docusaurus.config.js

@@ -15,7 +15,7 @@ module.exports = {
       },
       links: [
         {
-          to: 'docs/doc1',
+          to: 'docs/',
           activeBasePath: 'docs',
           label: 'Docs',
           position: 'left',
@@ -36,11 +36,11 @@ module.exports = {
           items: [
             {
               label: 'Style Guide',
-              to: 'docs/doc1',
+              to: 'docs/',
             },
             {
               label: 'Second Doc',
-              to: 'docs/doc2',
+              to: 'docs/doc2/',
             },
           ],
         },
@@ -83,6 +83,8 @@ module.exports = {
       '@docusaurus/preset-classic',
       {
         docs: {
+          // It is recommended to set document id as docs home page (`docs/` path).
+          homePageId: 'doc1',
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
           editUrl:

packages/docusaurus-init/templates/classic/src/pages/index.js

@@ -71,7 +71,7 @@ function Home() {
                 'button button--outline button--secondary button--lg',
                 styles.getStarted,
               )}
-              to={useBaseUrl('docs/doc1')}>
+              to={useBaseUrl('docs/')}>
               Get Started
             </Link>
           </div>

packages/docusaurus-init/templates/facebook/docusaurus.config.js

@@ -24,7 +24,7 @@ module.exports = {
       },
       links: [
         {
-          to: 'docs/doc1',
+          to: 'docs/',
           activeBasePath: 'docs',
           label: 'Docs',
           position: 'left',
@@ -46,7 +46,7 @@ module.exports = {
           items: [
             {
               label: 'Style Guide',
-              to: 'docs/doc1',
+              to: 'docs/',
             },
             {
               label: 'Second Doc',
@@ -117,6 +117,8 @@ module.exports = {
       '@docusaurus/preset-classic',
       {
         docs: {
+          // It is recommended to set document id as docs home page (`docs/` path).
+          homePageId: 'doc1',
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
           editUrl:

packages/docusaurus-init/templates/facebook/src/pages/index.js

@@ -80,7 +80,7 @@ function Home() {
                 'button button--outline button--secondary button--lg',
                 styles.getStarted,
               )}
-              to={useBaseUrl('docs/doc1')}>
+              to={useBaseUrl('docs/')}>
               Get Started
             </Link>
           </div>

website/docusaurus.config.js

@@ -99,15 +99,15 @@ module.exports = {
           items: [
             {
               label: versions[0],
-              to: 'docs/introduction',
+              to: 'docs/',
             },
             ...versions.slice(1).map((version) => ({
               label: version,
-              to: `docs/${version}/introduction`,
+              to: `docs/${version}/`,
             })),
             {
               label: 'Master/Unreleased',
-              to: 'docs/next/introduction',
+              to: 'docs/next/',
             },
           ],
         },