Skip to content

Commit

Permalink
feat: update documentation site (microsoft#1205)
Browse files Browse the repository at this point in the history
* update docs for linking directly to dev docs

* update docs site top menu

* update link for components to point to root

* remove build files

* update to components title

* update the autogenerated files created during publish

* update per PR comments
  • Loading branch information
awentzel authored Dec 21, 2018
1 parent a1cc1fd commit a7312e2
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ Teams spend significant time building parts of the design system (colors, variab
## Packages
[Lerna](https://github.com/lerna/lerna#independent-mode---independent) is used to organize and manage this mono repository. Most of these packages are published to NPM. Users can choose à la carte which utility service to use in their development efforts.

[Continue on Wiki...](https://github.com/Microsoft/fast-dna/wiki/Packages)

## Browser support
Cross browser testing based on web browser rendering engines.

Expand All @@ -26,7 +24,7 @@ Cross browser testing based on web browser rendering engines.
[![Build Status](https://saucelabs.com/buildstatus/FAST-DNA)](https://saucelabs.com/beta/builds/33e17283a9fb447ab220a8e00abe8f26)

## Documentation
Checkout the [developer documentation](https://microsoft.github.io/fast-dna) for guidance on getting started, contributing, consumption, quality, testing, help, and community policies.
Checkout the [developer documentation](https://microsoft.github.io/fast-dna/docs/readme) for guidance on getting started, contributing, consumption, quality, testing, help, and community policies.

## Contact
* Join the community [on Discord](https://discord.gg/FcSNfg4)
Expand Down
4 changes: 3 additions & 1 deletion website/i18n/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@
}
},
"links": {
"Docs": "Docs"
"Docs": "Docs",
"GitHub": "GitHub",
"Microsoft components": "Microsoft components"
},
"categories": {
"Getting started": "Getting started",
Expand Down
2 changes: 1 addition & 1 deletion website/pages/en/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ class HomeSplash extends React.Component {
<ProjectTitle />
<PromoSection>
<Button target="_blank" href="https://github.com/microsoft/fast-dna">GitHub</Button>
<Button target="_blank" href="https://msft-docs.fast-dna.net">Components</Button>
<Button target="_blank" href="https://msft-docs.fast-dna.net">Microsoft components</Button>
<Button href={docUrl('readme.html', language)}>Documentation</Button>
</PromoSection>
</div>
Expand Down
2 changes: 2 additions & 0 deletions website/siteConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ const siteConfig = {
// For no header links in the top nav bar -> headerLinks: [],
headerLinks: [
{doc: 'readme', label: 'Docs'},
{href: "https://github.com/microsoft/fast-dna", label: "GitHub"},
{href: "https://msft-docs.fast-dna.net", label: "Microsoft components"}
// {doc: 'doc4', label: 'API'},
// {page: 'help', label: 'Help'},
// {blog: true, label: 'Blog'},
Expand Down

0 comments on commit a7312e2

Please sign in to comment.