docs: update directory layout, document NEXT_PUBLIC_SITE_URL, scripts and fix formatting (#253, #254, #255, #256) - #297
Open
ghzhost wants to merge 1 commit into
Conversation
… and fix formatting (MergeFi#253, MergeFi#254, MergeFi#255, MergeFi#256)
|
Someone is attempting to deploy a commit to the chonilius' projects Team on Vercel. A member of the Team first needs to authorize it. |
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
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.
Description
Closes #253, closes #254, closes #255, closes #256.
This PR brings README.md and .env.example up to date with the actual project structure and capabilities:
src/to accurately includecontext/,hooks/,components/dashboard/, and the missinglib/modules (adapters.ts,auth.ts,env.ts,markdown.ts).NEXT_PUBLIC_SITE_URL(NEXT_PUBLIC_SITE_URL, read by sitemap.ts, is undocumented in both .env.example and README's environment variables table #256): DocumentsNEXT_PUBLIC_SITE_URLin both.env.exampleand the Environment variables table inREADME.md.npm test,npm run test:watch, andnpm run verify:envinREADME.md's Scripts table.<img>(README.md has a stray empty markdown bullet directly before an unindented <img> tag, breaking the repo-links list rendering #255): Removes stray bare bullet-and formats image spacing cleanly.Validation
npm run lintpasses with 0 warnings/errors.npm run buildsucceeds cleanly.