chore: update readme #2942
Merged
chore: update readme #2942
Conversation
This file contains 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
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
asyncapi-bot
requested review from
BhaswatiRoy,
J0SAL,
octonawish-akcodes,
TRohit20 and
VaishnaviNandakumar
akshatnema
requested changes
May 12, 2024
| ``` | ||
| npm run lint:fix | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Add an extra check regarding lint mdx as well.
There was a problem hiding this comment.
Should I update lint commands in package.json as given below:
"lint": "next lint && npx remark ./**/*.mdx",
"lint:fix": "next lint --fix && npx remark ./**/*.mdx"
Or should I add new commands for this:
"lint:mdx": "npx remark ./**/*.mdx"
There was a problem hiding this comment.
There is already a command as lint:mdx inside package.json.
devilkiller-ag
requested review from
quetzalliwrites,
derberg,
magicmatatjahu,
Mayaleeeee and
asyncapi-bot-eve
as code owners
akshatnema
requested changes
May 16, 2024
akshatnema
reviewed
May 17, 2024
README.md
Outdated
Comment on lines
256
to
280
| ├── .all-contributorsrc # File having details of all contributors | ||
| ├── .dockerignore # Docker ignore file | ||
| ├── .editorconfig # Editor configuration file | ||
| ├── .eslintrc # ESLint configuration file | ||
| ├── .gitignore # Git ignore file | ||
| ├── .gitpod.yml # Gitpod configuration file | ||
| ├── .remarkrc # Configuration file for remark | ||
| ├── ADDING_TRANSLATIONS.md # Guide on how to add translations | ||
| ├── CODE_OF_CONDUCT.md # Code of conduct | ||
| ├── Contributing.md # Contributing guidelines | ||
| ├── dashboard.json # Data for dashboard page | ||
| ├── Dockerfile # Dockerfile for building the website | ||
| ├── LICENSE # License file | ||
| ├── mlc_config.json # Configuration file for markdown-link-checker | ||
| ├── netlify.toml # Netlify configuration file | ||
| ├── next-env.d.ts # Next.js environment types | ||
| ├── next-i18next-static-site.config.js # Next.js i18next configuration file | ||
| ├── next.config.mjs # Next.js configuration file | ||
| ├── package-lock.json # NPM package lock file | ||
| ├── package.json # NPM package configuration file | ||
| ├── postcss.config.js # PostCSS configuration file | ||
| ├── README.md # Project's README file | ||
| ├── roadmap.json # Data for roadmap page | ||
| ├── tailwind.config.js # TailwindCSS configuration file | ||
| └── tsconfig.json # TypeScript configuration file |
There was a problem hiding this comment.
Add only about tailwind.config.js, tsconfig.json, next.config.mjs, README.md files.
quetzalliwrites
previously approved these changes
May 18, 2024
akshatnema
reviewed
May 18, 2024
akshatnema
approved these changes
May 18, 2024
|
/rtm |
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
Update the following in the readme:
Related issue(s)
#2636