docs: add documentation links to various components and configurations

README.md

@@ -6,7 +6,7 @@ MkSaaS is a complete Next.js boilerplate for building AI SaaS websites. Make mon
 
 ## Author
 
-This project is created by [Fox](https://x.com/indie_maker_fox), the founder of MkSaaS LLC and the creator of [Mkdirs](https://mkdirs.com), [IndieHub](https://indiehub.best) and some other websites.
+This project is created by [Fox](https://x.com/indie_maker_fox), the founder of [MkSaaS](https://mksaas.com) and [Mkdirs](https://mkdirs.com).
 
 ## Documentation
 
@@ -19,7 +19,7 @@ If you found anything that could be improved, please let me know.
 - website: [mksaas.com](https://mksaas.com)
 - demo: [demo.mksaas.com](https://demo.mksaas.com)
 - discord: [https://discord.gg/yVwpEtTT](https://discord.gg/yVwpEtTT)
-- documentation (WIP): [mksaas.com/docs](https://mksaas.com/docs)
+- documentation: [mksaas.com/docs](https://mksaas.com/docs)
 - video (WIP): [www.youtube.com/@MkSaaSHQ](https://www.youtube.com/@MkSaaSHQ) 
 - roadmap (WIP): [issues/17](https://github.com/MkSaaSHQ/mksaas-template/issues/17)
 

src/analytics/analytics.tsx

@@ -10,6 +10,9 @@ import { UmamiAnalytics } from './umami-analytics';
  *
  * 1. all the analytics components only work in production
  * 2. only work if the environment variable for the analytics is set
+ *
+ * docs:
+ * https://mksaas.com/docs/analytics
  */
 export function Analytics() {
   if (process.env.NODE_ENV !== 'production') {

src/components/layout/active-theme-provider.tsx

@@ -35,6 +35,9 @@ const ThemeContext = createContext<ThemeContextType | undefined>(undefined);
  * it will not be applied until the component is mounted,
  * for better user experience, we recommend to replace the
  * default theme with the custom theme in global.css.
+ *
+ * docs:
+ * https://mksaas.com/docs/themes
  */
 export function ActiveThemeProvider({
   children,

src/config/avatar-config.tsx

@@ -14,6 +14,9 @@ import { useTranslations } from 'next-intl';
  *
  * NOTICE: used in client components only
  *
+ * docs:
+ * https://mksaas.com/docs/config/avatar
+ *
  * @returns The avatar config with translated titles
  */
 export function getAvatarLinks(): MenuItem[] {

src/config/footer-config.tsx

@@ -9,6 +9,9 @@ import { useTranslations } from 'next-intl';
  *
  * NOTICE: used in client components only
  *
+ * docs:
+ * https://mksaas.com/docs/config/footer
+ *
  * @returns The footer config with translated titles
  */
 export function getFooterLinks(): NestedMenuItem[] {

src/config/navbar-config.tsx

@@ -39,6 +39,9 @@ import { useTranslations } from 'next-intl';
  *
  * NOTICE: used in client components only
  *
+ * docs:
+ * https://mksaas.com/docs/config/navbar
+ *
  * @returns The navbar config with translated titles and descriptions
  */
 export function getNavbarLinks(): NestedMenuItem[] {

src/config/price-config.tsx

@@ -11,6 +11,9 @@ import { websiteConfig } from './website';
  * If you need to get the price plans in server components, use getAllPricePlans instead.
  * Use this function when showing the pricing table or the billing card to the user.
  *
+ * docs:
+ * https://mksaas.com/docs/config/price
+ *
  * @returns The price plans with translated content
  */
 export function getPricePlans(): Record<string, PricePlan> {

src/config/sidebar-config.tsx

@@ -19,6 +19,9 @@ import { useTranslations } from 'next-intl';
  *
  * NOTICE: used in client components only
  *
+ * docs:
+ * https://mksaas.com/docs/config/sidebar
+ *
  * @returns The sidebar config with translated titles and descriptions
  */
 export function getSidebarLinks(): NestedMenuItem[] {

src/config/social-config.tsx

@@ -17,6 +17,9 @@ import { websiteConfig } from './website';
  *
  * NOTICE: used in client components only
  *
+ * docs:
+ * https://mksaas.com/docs/config/social
+ *
  * @returns The social config
  */
 export function getSocialLinks(): MenuItem[] {

src/config/website.tsx

@@ -3,6 +3,9 @@ import type { WebsiteConfig } from '@/types';
 
 /**
  * website config, without translations
+ *
+ * docs:
+ * https://mksaas.com/docs/config/website
  */
 export const websiteConfig: WebsiteConfig = {
   metadata: {

src/lib/auth.ts

@@ -13,6 +13,10 @@ import type { Locale } from 'next-intl';
 import { getUrlWithLocaleInCallbackUrl } from './urls/urls';
 
 /**
+ * Better Auth configuration
+ *
+ * docs:
+ * https://mksaas.com/docs/auth
  * https://www.better-auth.com/docs/reference/options
  */
 export const auth = betterAuth({

src/mail/index.ts

@@ -11,6 +11,7 @@ import {
   type SendRawEmailParams,
   type SendTemplateParams,
 } from './types';
+
 /**
  * Global mail provider instance
  */

src/mail/provider/resend.ts

@@ -10,6 +10,9 @@ import { Resend } from 'resend';
 
 /**
  * Resend mail provider implementation
+ *
+ * docs:
+ * https://mksaas.com/docs/email
  */
 export class ResendProvider implements MailProvider {
   private resend: Resend;

src/newsletter/provider/resend.ts

@@ -8,6 +8,9 @@ import { Resend } from 'resend';
 
 /**
  * Implementation of the NewsletterProvider interface using Resend
+ *
+ * docs:
+ * https://mksaas.com/docs/newsletter
  */
 export class ResendNewsletterProvider implements NewsletterProvider {
   private resend: Resend;

src/payment/provider/stripe.ts

@@ -24,6 +24,9 @@ import {
 
 /**
  * Stripe payment provider implementation
+ *
+ * docs:
+ * https://mksaas.com/docs/payment
  */
 export class StripeProvider implements PaymentProvider {
   private stripe: Stripe;

src/storage/provider/s3.ts

@@ -20,6 +20,9 @@ import {
 /**
  * Amazon S3 storage provider implementation
  *
+ * docs:
+ * https://mksaas.com/docs/storage
+ *
  * This provider works with Amazon S3 and compatible services like Cloudflare R2
  * https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html
  * https://www.npmjs.com/package/@aws-sdk/client-s3