updated documentation + vercel setup

CODE_OF_CONDUCT.md

@@ -0,0 +1,17 @@
+# Code of Conduct
+
+This project follows a strict code of conduct to ensure a safe and inclusive environment for all participants. We expect all contributors and users to adhere to the following guidelines:
+
+1. **Be respectful**: Treat others with respect and kindness. Do not engage in any form of harassment, discrimination, or offensive behavior.
+
+2. **Maintain a positive atmosphere**: Foster a welcoming and supportive community. Encourage constructive discussions and provide helpful feedback.
+
+3. **Collaborate effectively**: Work together in a cooperative and inclusive manner. Embrace diversity and value different perspectives.
+
+4. **Follow project guidelines**: Adhere to the project's technical guidelines and best practices. Contribute code and documentation that aligns with the project's goals.
+
+5. **Report any issues**: If you encounter any violations of the code of conduct or witness inappropriate behavior, please report it to the project maintainers.
+
+Failure to comply with this code of conduct may result in temporary or permanent exclusion from the project.
+
+Thank you for your cooperation in creating a positive and inclusive community.

CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing Guidelines
+
+Thank you for your interest in contributing to our project! We welcome contributions from the community to help improve our project and make it even better. Before you get started, please take a moment to review the following guidelines.
+
+## Getting Started
+
+To contribute to our project, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch for your contribution.
+3. Make your changes or additions.
+4. Test your changes to ensure they work as expected.
+5. Commit your changes and push them to your forked repository.
+6. Submit a pull request to our main repository.
+
+## Code Style
+
+We follow a specific code style in our project to maintain consistency and readability. Please make sure to adhere to the following guidelines:
+
+- Use meaningful variable and function names.
+- Indent code using spaces, not tabs. Use prettier to format your code if possible.
+- Use proper commenting to explain complex logic or algorithms.
+- Follow the naming conventions for files, classes, functions, and variables.
+
+## Reporting Issues
+
+If you encounter any issues or bugs while using our project, please report them by following these steps:
+
+1. Check if the issue has already been reported by searching our issue tracker.
+2. If the issue hasn't been reported, create a new issue and provide a detailed description of the problem.
+3. Include steps to reproduce the issue and any relevant error messages or screenshots.
+
+## Pull Request Guidelines
+
+When submitting a pull request, please ensure the following:
+
+1. Provide a clear and descriptive title for your pull request.
+2. Include a detailed description of the changes you have made.
+3. Reference any related issues or pull requests.
+4. Make sure your code passes all tests and doesn't introduce any new issues.
+5. Keep your pull request focused on a single feature or bug fix.
+
+## Code of Conduct
+
+We expect all contributors to adhere to our code of conduct. Please review our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
+
+Thank you for your contributions and helping us improve our project!

README.md

@@ -1,13 +1,35 @@
 # QvikChat Docs
 
-QvikChat Docs is a documentation website for QvikChat - Firebase Genkit + LangChain framework.
+QvikChat Docs is the documentation website for [QvikChat](https://github.com/oconva/qvikchat) framework.
 
-## Local Development
+**QvikChat** is a [Firebase Genkit](https://github.com/firebase/genkit) and [LangChain](https://js.langchain.com/v0.2/docs/introduction/) based framework that provides you with a solid foundation to build powerful AI-powered chat service endpoints quickly and efficiently. It includes support for **multiple types of conversations (open-ended, close-ended)**, **chat history**, **response caching**, **authentication**, and **information retrieval using Retrieval Augmented Generation (RAG).**
+
+[Get Started](https://qvikchat.pkural.ca/getting-started) | [Documentation](https://qvikchat.pkural.ca)
+
+## Documentation Website Local Development
 
 First, run `pnpm i` to install the dependencies.
 
 Then, run `pnpm dev` to start the development server and visit localhost:3000.
 
+## Contributions
+
+Contributions are welcome! Please refer to the [contribution guidelines](CONTRIBUTING.md) for more information.
+
+## Issues
+
+If you encounter any issues or bugs while using the starter kit, please report them by following these steps:
+
+1. Check if the issue has already been reported by searching our issue tracker.
+2. If the issue hasn't been reported, create a new issue and provide a detailed description of the problem.
+3. Include steps to reproduce the issue and any relevant error messages or screenshots.
+
+[Open Issue](https://github.com/oconva/qvikchat-docs/issues)
+
 ## License
 
 This project is licensed under the MIT License.
+
+## Credits
+
+This documentation website was created using [Nextra](https://github.com/shuding/nextra) site generation framework.

package.json

@@ -21,6 +21,7 @@
   "homepage": "https://github.com/oconva/qvikchat-docs#readme",
   "dependencies": {
     "@radix-ui/react-slot": "^1.1.0",
+    "@vercel/analytics": "^1.3.1",
     "class-variance-authority": "^0.7.0",
     "clsx": "^2.1.1",
     "lucide-react": "^0.399.0",

pages/_app.js

@@ -1,6 +1,9 @@
 import "../styles/global.css";
+import { inject } from "@vercel/analytics";
 
 // This default export is required in a new `pages/_app.js` file.
 export default function MyApp({ Component, pageProps }) {
+  // injext vercel analytics
+  inject();
   return <Component {...pageProps} />;
 }