{
  "attributes": {
    "id": "v4.0.0-guides-update",
    "title": "v4.0.0 Guides Enhancements",
    "protected": true,
    "linkText": "v4.0.0-guides-update"
  },
  "body": "{{#fountainhead-header tagName=\"h2\" elementId=\"better-guides\"}}Better Guides{{/fountainhead-header}}\n<p>Fountainhead v4 is focused on enhancing the guides feature. API documentation is\nimportant for end consumers of any library or application, but we think that guides\nhelp contributors and maintainers more than any resource. How many times have you\nwanted to contribute to a project, but then spent hours trying to decipher how the\nproject is structured, how internal modules are used… and ended up not sure where\nto even start?</p>\n<p>Well named variables and methods go a long way towards self documenting code, but\nguides are the bridge between the <em>HOW</em> and the <em>WHY</em> in a project. However writing\nguides has been difficult in the past, and often the solution has been a static site\ngenerator in a different repo or branch in a project <em>(which almost always gets out\nof sync)</em>.</p>\n<p>The Fountainhead guides udpate aims to make writing guides less of a hassle by:</p>\n<ul>\n<li>Adding auto discovery of guides in the <code>/guides</code> directory. It's possible to create\nan entire set of guides for your project with zero configuration.</li>\n<li>Adding 'Guide Groups' so that you can group relevant guides together. This makes it\neasier to organize your guides, and keeps your guide's navigation organized.</li>\n<li>Adding access levels <code>protected</code> and <code>private</code> to guides. This can be used to work\non guides that aren't ready to publish, or create guides that you would like\nparsed and formatted but not included in the guide navigation. (This release document\nis an example of using <code>protected</code> to generate a formatted release guide that we\ncan internally link to in the Releases page).</li>\n</ul>\n<p>We've updated the {{link-to 'Writing Guides' 'guides' 'writing-guides'}} guide with\nadditional details and tips for writing helpful guides.</p>\n{{#fountainhead-header tagName=\"h2\" elementId=\"breaking-changes\"}}Breaking Changes{{/fountainhead-header}}\n<p>All breaking changes in v4 are internal component changes. If you are not extending\nFountainhead navigation components, there should not be breaking changes for you.</p>\n<p>Note that you may be able to remove the <code>fountainhead.guides</code> config, see Auto\nDiscovery in {{link-to 'Writing Guides' 'guides' 'writing-guides'}} for details.</p>\n<p>Breaking Changes:</p>\n<ul>\n<li><code>fountainhead-sidebar/*</code> component exports removed</li>\n<li><code>api-navigation/*</code> components renamed to <code>navigation-api/*</code> components</li>\n<li><code>guide-navigation</code> component renamed to <code>navigation-guide</code></li>\n</ul>\n",
  "frontmatter": "id: v4.0.0-guides-update\ntitle: v4.0.0 Guides Enhancements\nprotected: true",
  "id": "v4.0.0-guides-update",
  "type": "guides"
}