Broken link under Examples section of "Creating your themes" page:

[source code](https://github.com/pedronauck/docz/tree/master/core/docz-theme-default) of `docz-theme-default`

Original issue: doczjs/docz#1090

PR to probably fix: #76

It's not included in the API reference or in the guide. I was able to figure it out for the most part but I'd like to have something to refer to for myself and other developers.

Soon you can use DEBUG=docz* via debug

We should document it.

https://www.docz.site/docs/migration-guide has some links to https://www.docz.site/docs/h

Tried to run the dev script, but got this error:

ERROR  Failed to compile with 14 errors                                                                                                                                    19:20:11
These dependencies were not found:

* docs  hemesindex.mdx in ./.docz/app/imports.js
* docsdocumentationindex.mdx in ./.docz/app/imports.js
* docsdocumentationpagescomponents-apiindex.mdx in ./.docz/app/imports.js
* docsdocumentationpagescreating-pluginsindex.mdx in ./.docz/app/imports.js
* docsdocumentationpagescreating-themesindex.mdx in ./.docz/app/imports.js
* docsdocumentationpagesproject-configurationindex.mdx in ./.docz/app/imports.js
* docshomeindex.mdx in ./.docz/app/imports.js
* docsintroductionindex.mdx in ./.docz/app/imports.js
* docsintroductionpagescustomizingindex.mdx in ./.docz/app/imports.js
* docsintroductionpagesdeploying-your-docsindex.mdx in ./.docz/app/imports.js
* docsintroductionpagesdocumenting-your-thingsindex.mdx in ./.docz/app/imports.js
* docsintroductionpagesgetting-startedindex.mdx in ./.docz/app/imports.js
* docsintroductionpageswriting-mdxindex.mdx in ./.docz/app/imports.js
* docspluginsindex.mdx in ./.docz/app/imports.js

i was getting Error: Cannot find module 'typescript' errors until i realized that i have to manually install typescript myself as it is a peer dep. for some reason your example repo doesnt need typescript as an explicit dependency.

also the typescript:true flag is hard to find and should be better known. probably a standalone typescript doc is good for all these small things.

i'm getting this based on just doing yarn dev on the current master:

This dependency was not found:

* null in ./.docz/app/root.jsx

To install it, you can run: npm install --save null

that file has this weird code:

import Wrapper from 'null'

const Root = () => <Theme hashRouter={undefined} wrapper={Wrapper} />

export default hot(module)(Root)

after i install the null package:

not sure what is going on but just sharing

Would be great if the docs serve as a demo as well. Better than a video.

Applies to PropsTable, Playground etc.

I'm looking at examples on how to use docz on my docs site and it would be great if this repo would be up to date with the docz itself 😉

doczjs/docz#1191

mdPlugins -> gatsbyRemarkPlugins

Related to #25 but deployed site https://www.docz.site/ currently does not have a favicon.

On Firefox https://www.docz.site/ flashes with its header for a fraction of second and disappears. Was checked on Firefox 66 (64 bit) on Ubuntu and on Mac OS with different network connections. The website works on Chromium on the same machines correctly.

Favicon Documentation Request

Hey guys, I posted a comment in this issue here and I'll port it over here. This is a request for documentation on how to get a favicon working.

I tried adding a favicon based on the instructions here and they didn't work for me. I found a solution that works in the meantime by adding an external link in the doczrc.js for the favicon.

External favicon link

// doczrc.js
export default {
  htmlContext: {
    favicon: 'https://s3-us-west-1.amazonaws.com/set-protocol/favicon.ico',
  },
}

I added this and reran yarn dev which showed the favicon for me. This is mostly a bandaid solution to unblock some folks who are running into the same issue.

I'm sure others are having the same issue by looking down the list of projects using docz who are missing favicons.

Testing Other Repos

I tested the docz-website and island-wars repos, both of which have working deployed favicons. When running both of them locally, I didn't see working favicons.

docz-site

When running the docz-website locally, and saw that the favicon for the site wasn't working for me. It's confusing because the doczrc.js leads to an .ico file, but the path doesn't match up to anything inside of the public folder. The only favicon I see is a favicon in the public/images folder which is a .png file. When looking in the source code on docz.site, the favicon link doesn't lead to anything. Would be useful to get clarification on how it works.

island-wars

I saw one repo in the list above that had a working favicon, and running that locally also didn't show a favicon. I did see a useful commit from there that I followed and didn't get me working favicon using that method. Their site does link to the proper favicon.

Production Builds

I questioned whether it was because I wasn't using a production build, so I deployed to Netlify, but also didn't see a working favicon.

Several pages have links to the Docz default theme in the GitHub repo's URL, which was moved from /packages to /core and need to be fixed:

• Customizing
• Creating Themes
• Project Configuration
• Themes

Add docgenConfig documentation here 👍 https://www.docz.site/docs/project-configuration

Related :

• doczjs/docz#1316
• doczjs/docz#1317

In .doczrc.js documentation, it seems there is a mistake with source property name.

It's not source property but src property instead.

Because, in v0.3.3, when I set source: './src' it's not working, but when I set src: './src', it works.

https://github.com/pedronauck/docz-website/blob/64eea671b4ceb428223ab930eec6cdff7c7fe6f7/docs/documentation/pages/project-configuration/index.mdx#L20-L29

hey Pedro,

i'd like to offer my help maintaining the docs. i think it could help the onboarding experience esp like this - doczjs/docz#576

i sincerely want this project to take over design system development and i think it we need to lead by example with great docs.

thank you
shawn

Hi,
Could you please add LICENSE file and put the copyright holder and license inside each file?

This way there is no chance of someone stumbling across a piece of code without being exposed to the license.

Thanks!