Feature/docs #58
Merged
Feature/docs #58
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…eference and environment variable configuration
…n, and refine documentation links for consistency
- Changed the download command for the docker-compose file to use the SQLite version instead of the previous production YAML file.
- Updated the Docusaurus configuration to include a custom Tailwind CSS plugin. - Added new Docker installation documentation for MongoDB, Postgres, and SQLite. - Improved existing documentation by refining key features and quick start sections. - Removed outdated manual installation guide and several tutorial files to streamline content. - Updated package dependencies in pnpm-lock.yaml for Tailwind CSS and PostCSS. - Enhanced the homepage with new components for better user experience.
- Updated database configuration to recognize "mongodb" as an alias for "mongo". - Added a new health check endpoint to the server for improved monitoring. - Configured Nginx to prevent caching of the environment configuration file (env.js) for better deployment flexibility.
…ement - Changed the "Get Started" button to "Docs" for clearer navigation. - Added a new "Live Demo" button linking to the demo site for users to experience Peekaping in action. - Updated the introduction section to promote the live demo instead of the Docker installation link. - Introduced a new index.tsx file for the homepage layout, integrating key components for enhanced user experience.
- Removed unnecessary components from the homepage, including HomepageFeatures, HomepageHeader, KeyFeatures, and associated styles. - Updated Docusaurus configuration to disable the blog feature. - Adjusted the introduction section to set the slug to the root path for better navigation.
- Restructured the homepage layout for better organization and user experience. - Updated navigation elements to streamline access to key features and documentation. - Removed deprecated components to simplify the codebase and improve performance.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
- Eliminated the "Docs" section from the footer links to streamline the configuration. - Focused on enhancing the community section for better user engagement.
There was a problem hiding this comment.
Bug: Domain Mismatch in CNAME File
The apps/docs/static/CNAME file contains the placeholder domain "docs.yourdomain.com". This conflicts with the docusaurus configuration, which specifies "docs.peekaping.com" as the intended URL. This mismatch will cause GitHub Pages deployment to fail or use an incorrect custom domain.
apps/docs/static/CNAME#L1-L1
peekaping/apps/docs/static/CNAME
Line 1 in 55d560d
Was this report helpful? Give feedback by reacting with 👍 or 👎
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.