dailydotdev / docs Goto Github PK

View Code? Open in Web Editor NEW

292.0 7.0 155.0 3.51 MB

The official product docs of daily.dev

Home Page: https://docs.daily.dev

License: GNU Affero General Public License v3.0

JavaScript 43.25% CSS 56.40% Dockerfile 0.35%

developer-tools documentation docusaurus productivity hacktoberfest

docs's Introduction

📝 The official daily.dev Documentation

The daily.dev docs are designed to help our community members get the most out of the product. Hope you will find it useful! We welcome your contribution to help us make it better and up-to-date 💜

👨‍💻 Contributing

Contributions make the open source community such an amazing place to learn, inspire, and create.
Any contributions you make are truly appreciated
Provide clear documentation
Create descriptive pull requests
Test your changes

💻 Development

Fork the project: Click the gray Fork button in the top right of this page. This creates your copy of the project and saves it as a new repository in your github account
Click on the green Code button, then either the HTTPS or SSH option and, click the icon to copy the URL. Now you have a copy of the project. Thus, you can play around with it locally on your computer.
Run the following commands into a terminal window (Command Prompt, Powershell, Terminal, Git Bash, ZSH):

Do this to download the forked copy of this repository to your computer:

git clone https://github.com/dailydotdev/docs.git

Step into the directory:

cd docs

Ensure you are on the correct node version:

nvm use

Install the dependencies:

# with npm
npm i

# or with yarn
yarn

# or with pnpm
pnpm i

Run the local dev environment:

# with npm
npm run start

# or with yarn
yarn start

# or with pnpm
pnpm start

Now Visit:

http://localhost:3000

🚀 Deployment

Build the project:

# with npm
npm run build

# or with yarn
yarn build

# or with pnpm
pnpm build

Run the server:

# with npm
npm run serve

# or with yarn
yarn serve

# or with pnpm
pnpm serve

The server is available by default on port 3000.

🐳 Deployment with Docker

From the folder where the docker-compose.yml file is located, type:

docker compose up --build

The server is available by default on port 3000.

🍿 Test

docker run -p 3000:3000 francescoxx/dailydev-docs:0.9.3

🙏 Thanks to all Contributors

Thanks a lot for spending your time in helping daily.dev grow. Thanks a lot! ❤️

📑 License

Licensed under AGPL-3.0.

⭐️ One more thing

Don't forget to leave us a star ⭐️

docs's People

Contributors

Stargazers

Watchers

Forkers

nimrodkra ronlin1 vishnuku syedsohan shubh28698 rebelchris 7u4 mr-destructive developer-diganta dammy001 dazlygonsalves nnennandukwe sieis seanom argousiere matteogauthier sansk afuzzybear adarsh-jaiss eliudkip grahamthedev kishoreandra aditya12gusain grahamgrilli karlgusta naseeba-shah psphilippe rahmaniftaliyev just-moh-it sumitsaurabh927 niyi1974 twizelissa michaelsilber omar8345 murtuzaalisurti pfawaz saadh393 piyush-multiplexer njong392 basefox panquesito7 saptarshisarkar12 maxnsimba vaishnav-sh she3e lpmedux shadowconquer markuseicher som-sama dnyaneshvn dunnjacoba pradumnasaraf nikhilxe harshalyadav yashdev9274 alidhuniya gitansh0204 sachinparihar vignesh-02 ayushchamoli961 manojku1803 nitishmalang niravprajapati1 ayushh7 thinkverse abhisheksr98 thisiskaransgit achmadalli sanyam2301 kull-boii slorber yogeshrajput335 rahul-kumar-prog th1983 abhinandkrishna20 spiritdivine yoisar dev-praise manongdemi jehankandy manojkr6637 rahulpandey70 soi-20 devanshukoli preetisalhotra24 himanshu1221 cadamini holkexyz thankgodode mikeb275 mudassirali007 khushalarora kumarankit999 andrei0872 krupalitrivedi seomaster888 kishangupta114 leggetter dwalt825 imbios

docs's Issues

Word breaks for small screen

I noticed that the word installation was broken when I tried it on a small screen. Can I work on this to fix it?

[Box-shadow] <add box-shadows to the cards>

Description

Improve the cards by adding box-shadows to them

Screenshots

No response

Additional information

No response

[FEATURE] Automate the Algolia Crawler

Description

Automate the Algolia Crawler

https://www.algolia.com/doc/tools/crawler/apis/configuration/schedule/

Screenshots

No response

Additional information

No response

Bug

The YouTube video iFrame is not responsive.

How it looks

Solution

Set the height and width of the iFrame like this:

{
    width: 100%;
    height: auto;
    aspect-ratio: 16/9;
}

chrome_BHBURhM6eZ.mp4

I was about to make a PR but I don't know where to add the styles!

Run the build command on a github action

Phrases could be combined for better reading.

In the progressive web app section, (here specifically https://docs.daily.dev/docs/getting-started/pwa#how-can-i-add-dailydev-to-my-mobile-home-screen-on-ios) there are two following phrases.
For iOS users, you can add a website icon to your iPhone Home Screen!
You can add a website icon to your iPhone Home Screen for quick access to that site.

They both almost read the same, and I think merging the two would sort of make it read better. Something along the lines of,
For iOS users, you can add a website icon to your iPhone Home screen for quick access to that site.

Added command of update npm

Description

some user are using old version of npm that's why they not able to run some actions, so i added update npm command.

Screenshots

Additional information

No response

Add alt to banner image

The banner image doesn't have an alt so it is affecting the SEO and acccessibility.

Typo in a phrase

Link

https://docs.daily.dev/docs/key-features/default-feeds#popular-feed

Proposed changes

The very first statement under this small heading,
Most popular articles a listed first. should be Most popular articles are listed first. I think.

And then the thrid bullet point right after that,
The freshness of the article (e.g., when as it published) should be The freshness of the article (e.g., when it was published) or to correct the typo, The freshness of the article (e.g., when was it published?)

(So sorry in advance for the (many) issues I'm raising when they could just be PRs 😂 Maybe these could be tagged as good first issues since they are fairly easy to handle, and could be good for people contributing for the very first time 👍 .)

Create pull request/issue template

With a PR or issue template, it's easier for contributors to provide structured issues and pull requests. That way, we know what they are fixing, where they are fixing it, screenshots and all the like.

[FEATURE] Play YT videos on the same page

I want to improve the docs website by making the YT videos played by the users on the same page without leaving the page.

Page Crashed🐛 BUG:

What went wrong? 🤔

The homepage keeps crashing when trying to deploy or run from localhost for inspection.
There's an error with hooks been improperly used or an old version of react.

Expected Behavior

Expected to show homepage or viewpage

Steps to Reproduce Issue

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See the error

Solution Proposed

No response

Screenshots

No response

Environment

windows 10

Browsers

No response

OS

No response

Version of daily.dev

No response

Additional Context

Uncaught runtime errors:
×
ERROR
Invalid hook call. Hooks can only be called inside of the body of a function component. This could happen for one of the following reasons:
1. You might have mismatching versions of React and the renderer (such as React DOM)
2. You might be breaking the Rules of Hooks
3. You might have more than one copy of React in the same app
See https://reactjs.org/link/invalid-hook-call for tips about how to debug and fix this problem.
Error: Invalid hook call. Hooks can only be called inside of the body of a function component. This could happen for one of the following reasons:
1. You might have mismatching versions of React and the renderer (such as React DOM)
2. You might be breaking the Rules of Hooks
3. You might have more than one copy of React in the same app
See https://reactjs.org/link/invalid-hook-call for tips about how to debug and fix this problem.
    at resolveDispatcher (webpack-internal:///./node_modules/react/cjs/react.development.js?1b7e1:1476:13)
    at useEffect (webpack-internal:///./node_modules/react/cjs/react.development.js?1b7e1:1519:20)
    at useKeyboardNavigation (webpack-internal:///./node_modules/@docusaurus/theme-common/lib/hooks/useKeyboardNavigation.js:22:85)
    at Layout (webpack-internal:///./node_modules/@docusaurus/theme-classic/lib/theme/Layout/index.js:25:115)
    at renderWithHooks (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:14985:18)
    at mountIndeterminateComponent (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:17811:13)
    at beginWork (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:19049:16)
    at HTMLUnknownElement.callCallback (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:3945:14)
    at Object.invokeGuardedCallbackDev (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:3994:16)
    at invokeGuardedCallback (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:4056:31)
ERROR
Invalid hook call. Hooks can only be called inside of the body of a function component. This could happen for one of the following reasons:
1. You might have mismatching versions of React and the renderer (such as React DOM)
2. You might be breaking the Rules of Hooks
3. You might have more than one copy of React in the same app
See https://reactjs.org/link/invalid-hook-call for tips about how to debug and fix this problem.
Error: Invalid hook call. Hooks can only be called inside of the body of a function component. This could happen for one of the following reasons:
1. You might have mismatching versions of React and the renderer (such as React DOM)
2. You might be breaking the Rules of Hooks
3. You might have more than one copy of React in the same app
See https://reactjs.org/link/invalid-hook-call for tips about how to debug and fix this problem.
    at resolveDispatcher (webpack-internal:///./node_modules/react/cjs/react.development.js?1b7e1:1476:13)
    at useEffect (webpack-internal:///./node_modules/react/cjs/react.development.js?1b7e1:1519:20)
    at useKeyboardNavigation (webpack-internal:///./node_modules/@docusaurus/theme-common/lib/hooks/useKeyboardNavigation.js:22:85)
    at Layout (webpack-internal:///./node_modules/@docusaurus/theme-classic/lib/theme/Layout/index.js:25:115)
    at renderWithHooks (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:14985:18)
    at mountIndeterminateComponent (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:17811:13)
    at beginWork (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:19049:16)
    at HTMLUnknownElement.callCallback (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:3945:14)
    at Object.invokeGuardedCallbackDev (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:3994:16)
    at invokeGuardedCallback (webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js?ac890:4056:31)

Code of Conduct

I follow the conditions of this project.

[Readme Update] Adding more contributing guidelines to readme file

ISSUE

Contrbuting guidelines are not that much informatve.

SOLUTION

By addingmore bullet points in readme.md (which will make it more long).
By adding another Markdownn File which will redirect you to contributing guidelines which wil more more helpfull.

IMAGE

[DOCS] Added some added necessary punctuation marks

Fixed some typo's and added necessary punctuation marks

Accessibility issues on the links

On the docs website, when dark mode is turned on, all the links have a gray color with a black background. This makes for a bad contrast between the text and it is bad for accessibility for people with low vision.

I checked it on the dev tools and here's what I got:

The contrast fails on both the recommended WCAG levels: AA and AAA. The contrast ratio is significantly low at 3.9.

The minimum acceptable ratio comes as 5.72:

And to pass both the levels we need it to be around 7.11:

I tried to dig into the codebase to change the color code myself but it seems that it uses the default prism-react-renderer theme as described in the docusaurus.config.js file:

const darkCodeTheme = require('prism-react-renderer/themes/dracula');

I don't know how to change it then because I guess the color: hsl(1deg 1% 63%); property is coming from that package only.

Please fix it so that the accessibility improves and it's better to read.

Wording(tense) could be improved upon

Right over here, https://docs.daily.dev/docs/getting-started/browser-extension-installation#enabling-chromes-most-visited-sites-and-custom-shortcuts

Just below the first screenshot, you have, Once you clicked, you will see the following options. Suggesting that the word clicked be changed to click or that the phrase be changed to Once you've clicked, you will see the following options

Need Dark / Light Mode Toggler for Mobile Screens as well.

Description

Currently Theme toggler button is available for desktop devices only, hence it would be great if it is available for mobile devices as well.

Screenshots

Additional information

Assign the issue to me so I can fix it.

[FEATURE] Please add support for Safari Browser.

Description

Daily.dev extension isn't available on the safari platform, I am requesting a Feature request for a safari extension. An Unofficial Free Extension will also work.

Screenshots

No response

Additional information

No response

Wording(tense) could be adjusted

Right over here, https://docs.daily.dev/docs/getting-started/browser-extension-installation#enabling-chromes-most-visited-sites-and-custom-shortcuts

Automate testing

Is it deployed?

Search Component : Focus State UI of Search Input wasn't looks good

Description

When I click the Search Option in Navbar, will get a Search Component, in that when i start typing to search. The focus state of that input Search component wasn't looks good

Screenshots

Additional information

The correct fix is:

[FEATURE] <want to change the color of star>

Description

In key feature block there is a star , but to change the color from black to yellow it would look great.

Screenshots

No response

Additional information

No response

feat: automate build on every change

I think it will be useful to run the build command on every change to check the project still works

Example GitHub for the pull request .github/workflows/build.yml

name: Build
on:
  push:
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v2
        with:
          node-version: '16'
      - name: install dependencies
        run: npm ci
      - name: run build
        run: npm run build

Add contributor label to readme file

Like that

Search Bar is not working properly

Description

Whenever you clicked on the search bar the actual search bar get overlapped with the nav bar and couldn't able to see the search bar

Screenshots

Additional information

No response

Crashing on changing filters

In settings, whenever I try to change the filter from "Last Year" to any other year, it crashes.

I would like to help in fixing the issue.

Just let me know about the steps to follow.

feat: search bar border fix in dark mode

Description

On switching to dark mode, the border on the search bar disappears due to its color matching the background color for dark mode. Would love to have this assigned to me so I can fix it.

Screenshots

Additional information

No response

Change in the design of the content

footer bug

Description

Screenshots

No response

Additional information

No response

typo: we are tiktok

Description

The promotion card reads "We are TikTok". I think it's supposed to be "We are on Tiktok"

Screenshots

Additional information

No response

Add CONTRIBUTING.md & CODE_OF_CONDUCT.md into this Project.

I guess it would be great if we add CONTRIBUTING.md & CODE_OF_CONDUCT.md in this Project for first-timers as they will look after this two in this project. I know there is already CONTRIBUTING.md & CODE_OF_CONDUCT.md in .github this repository.

Replacing a full stop with an exclamation sign

I think an exclamation mark after a new user installs the extension captures the excitement better!

So, it should be Just install it, open a new tab, and you're all set! like how it is for Try our progressive web app!

No tags in the version in the pakage.json

Clarification of documentations

Description

Within content-guidelines it states "❌ It is a personal blog (global thought-leaders excluded)."
Does this mean that every blog written by yourself will be rejected, or is a personal blog more narrow in its definition?

Scenario 1: I write a blog about my thoughts about ChatGPT (I am NOT a global thought-leader), this will be rejected
Scenario 2: I write a blog about how to use ChatGPT for writing python code, is this a personal blog?
Scenario 3: I scout a blog of someone's (I do not know) thoughts about ChatGPT, will this be a personal blog?

Summary questions:
I there a scenario where I can share a blog/article I wrote myself on daily.dev?
Are all opinion pieces of none global thought-leaders automatically rejected?

Screenshots

No response

Additional information

No response

Question mark required

Link

https://docs.daily.dev/docs/settingyourfeed/filtering-content-feed#choose-tags

Issue

a) Point 3 talks about searching tags. A phrase there reads Didn't find the tag you were looking for, use the search to find...
b) The info quote card just after point 3 mentioned above has text along the lines of Wondering how does daily.dev classify articles? Learn more about...

Proposed changes

for a) After Didn't find the tag you were looking for I think there should be a question mark before continuing with use the search to find... That way, the phrase can read as Didn't find the tag you were looking for? Use the search to find...

for b) Suggesting that the aforementioned be rephrased to Wondering how daily.dev classifies articles? Learn more about...

Improve Card Design

Assign this issue to me

Adding links to privacy policy and terms of service.

I think it would be helpful if these two were directly linked to their respective pages..

Typo in heading

Link

https://docs.daily.dev/docs/settingyourfeed/blocking-tags-sources#how-does-blocking-works

Issue

Heading reads as How does blocking works?

Proposed solution

The s at the end can be gotten rid of. This way the topic becomes How does blocking work?, which sounds a lot better.

Search bar not working on Mobile

Description

When the search icon is clicked the search field shows behind a pop up as shown in the screenshot

Screenshots

Additional information

It doesn't allow get a view of what they typing

[FEATURE] PNPM-support in docs for inclusivity

Description

Add the PNPM command explicitly in README.md to tell people who use PNPM that this repository is PNPM-friendly and easier for them to copy-paste the code.

Screenshots

No response

Additional information

No response

Bugs and Templates

Name	About	Labels	Assignees
🐛 Bug	Report an issue to help improve the project.	🛠 goal: fix

Description A brief description of the question or issue, also include what you tried and what didn't work <textarea class="issue-form-textarea form-control js-structured-issue-textarea-expander js-session-resumable" required="required" disabled="disabled" aria-describedby="description-description" data-test-selector="issue-form-textarea-element" name="issue_form[description]" id="issue_form_description" style="box-sizing: border-box; font-style: inherit; font-variant: inherit; font-weight: inherit; font-stretch: inherit; font-size: 14px; line-height: 1.5; font-family: inherit; margin: 0px 5px 0px 0px; overflow: auto; padding: 8px 12px; color: var(--color-primer-fg-disabled); vertical-align: middle; background-color: var(--color-canvas-inset); background-repeat: no-repeat; background-position: right 8px center; border-color: var(--color-border-default); border-top-style: ; border-top-width: ; border-right-style: ; border-right-width: ; border-bottom-style: ; border-bottom-width: ; border-left-style: ; border-left-width: ; border-image-source: ; border-image-slice: ; border-image-width: ; border-image-outset: ; border-image-repeat: ; border-radius: 6px; box-shadow: var(--color-primer-shadow-inset); transition: color 80ms cubic-bezier(0.33, 1, 0.68, 1) 0s, background-color, box-shadow, border-color; height: 200px; min-height: 200px; -webkit-text-fill-color: var(--color-primer-fg-disabled); opacity: 1; width: 1134px; max-width: 100%;"></textarea> Screenshots Please add screenshots if applicable <textarea class="issue-form-textarea form-control js-structured-issue-textarea-expander js-session-resumable" disabled="disabled" aria-describedby="description-screenshots" data-test-selector="issue-form-textarea-element" name="issue_form[screenshots]" id="issue_form_screenshots" style="box-sizing: border-box; font-style: inherit; font-variant: inherit; font-weight: inherit; font-stretch: inherit; font-size: 14px; line-height: 1.5; font-family: inherit; margin: 0px 5px 0px 0px; overflow: auto; padding: 8px 12px; color: var(--color-primer-fg-disabled); vertical-align: middle; background-color: var(--color-canvas-inset); background-repeat: no-repeat; background-position: right 8px center; border-color: var(--color-border-default); border-top-style: ; border-top-width: ; border-right-style: ; border-right-width: ; border-bottom-style: ; border-bottom-width: ; border-left-style: ; border-left-width: ; border-image-source: ; border-image-slice: ; border-image-width: ; border-image-outset: ; border-image-repeat: ; border-radius: 6px; box-shadow: var(--color-primer-shadow-inset); transition: color 80ms cubic-bezier(0.33, 1, 0.68, 1) 0s, background-color, box-shadow, border-color; height: 200px; min-height: 200px; -webkit-text-fill-color: var(--color-primer-fg-disabled); opacity: 1; width: 1134px; max-width: 100%;"></textarea> Additional information Is there anything else we should know about this bug?

.

Docs: Fix links

FIX LINKS: The links seem to broken. I keep getting "404 Error" when I tried navigating through them.

Add Thanks to the all Contributors & Support in README.md

I know it is not mandatory but it would be good if we add two sections of Thanks to all Contributors and Support.

Thanks to the all Contributors - Thanks a lot for spending your time helping with The official product docs daily.dev grow. Thanks a lot!
Support - This project needs a ⭐️ from you. Don't forget to leave a star ⭐️

Typo in table

Link

https://docs.daily.dev/docs/settingyourfeed/advanced-filtering-options#available-content-categories

Issue

On the table, in the second column, under the description of Non-editorial content, it says "Show user-generated posts that we're created on external blogging platforms"

Proposed changes

The word we're should be changed to were to fit the context, so that phrase reads as "Show user-generated posts that were created on external blogging platforms"