add link to documentation

Author: gregrickaby

.env.sample

@@ -1,3 +1,5 @@
+# Learn more about ENV variables at https://github.com/WebDevStudios/nextjs-wordpress-starter/wiki
+
 # Tells next.js we're in development mode
 VERCEL_ENV="development"
 

.eslintrc.js

@@ -1,3 +1,4 @@
+// https://eslint.org/docs/user-guide/configuring/
 module.exports = {
   parserOptions: {
     ecmaFeatures: {

api/algolia/connector.js

@@ -1,5 +1,5 @@
-import algoliasearch from 'algoliasearch/lite'
 import getEnvVar from '@/functions/getEnvVar'
+import algoliasearch from 'algoliasearch/lite'
 
 // Define env vars.
 export const algoliaIndexName = getEnvVar('ALGOLIA_INDEX_NAME', true)
@@ -8,6 +8,7 @@ export const algoliaAppId = process.env.NEXT_PUBLIC_ALGOLIA_APPLICATION_ID
 
 const algoliaClient = algoliasearch(algoliaAppId, algoliaSearchKey)
 
+// https://www.algolia.com/doc/api-client/getting-started/what-is-the-api-client/javascript/?client=javascript
 export const searchClient = {
   search(requests) {
     if (requests.every(({params}) => !params.query)) {

api/apolloConfig.js

@@ -1,6 +1,6 @@
-import {useMemo} from 'react'
 import merge from 'deepmerge'
 import isEqual from 'lodash/isEqual'
+import {useMemo} from 'react'
 import {initializeWpApollo} from './wordpress/connector'
 
 // Set global state name.
@@ -10,6 +10,9 @@ export const APOLLO_STATE_PROP_NAME = '__APOLLO_STATE__'
  * Init Apollo and merge with initial state.
  *
  * @author WebDevStudios
+ *
+ * @see https://www.apollographql.com/docs/react/get-started/
+ *
  * @param {object} apolloClient Apollo client instance.
  * @param {*}      initialState The initial state of things.
  * @return {object}             Apollo client instance.

postcss.config.js

@@ -1,3 +1,4 @@
+// https://nextjs.org/docs/advanced-features/customizing-postcss-config#customizing-plugins
 module.exports = {
   plugins: {
     tailwindcss: {},

prettier.config.js

@@ -1,3 +1,4 @@
+// https://prettier.io/docs/en/configuration.html
 module.exports = {
   tabWidth: 2,
   useTabs: false,

stylelint.config.js

@@ -1,3 +1,4 @@
+// https://stylelint.io/user-guide/configure
 module.exports = {
   extends: ['stylelint-config-standard'],
   rules: {

tailwind.config.js

@@ -1,3 +1,4 @@
+// https://tailwindcss.com/docs/installation#create-your-configuration-file
 module.exports = {
   purge: {
     content: [