Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dacumentation-page #1

Merged
merged 24 commits into from
Jun 2, 2024
Merged

Dacumentation-page #1

merged 24 commits into from
Jun 2, 2024

Conversation

latifa-wakili
Copy link
Owner

new repo about a Dacumentation-page
iclude this files:
index.html
styles.css
README.md

Copy link

@ahzamir ahzamir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @latifa-wakili 🙋‍♀️,

Excellent work! You have done a great job implementing the project requirements but your project still misses some of the requirements:

  • Well done, your code passes all the tests on freecodecamp.
  • Your HTML code is not clean for more details check the inline comments below.
  • You have to update your README.md file and add your own project details.

Status: Required Changes 🔁

Make changes to your code and commit and request for a re-review.

AlmostThereReachGIF

Highlights 🌞

🎯 Great Design implemented.
image
✔️ Created a professional Repo (You created a repository with your project name)
✔️ Correct use of Gitflow (You created the development branch and made it your default branch, then created and committed your work on your feature branch)
✔️ Commit messages are meaningful
✔️ Setup the linters correctly (You added the correct linters config into your project according to the language you used on your code)
✔️ No linter errors (All linters checks have been passed 🟢)
✔️ You have followed and completed the Technical Documentation Page and all requirements.
✔️ Created the pull request (From your feature branch to the development branch you created a pull request and submitted the pull request link for review)
✔️ Good PR description (You added a meaningful description to your PR about your work and the features you added on this pull request)
✔️Your Project has a README.md file
❌Your README.md contains your project details
❌Your code is clean

Cheers 🥂 and Happy coding!!! 👯 Feel free to leave any questions or comments in the PR thread if something is not 100% clear. Please, remember to tag me @ahzamir in your question so I can receive the notification.

index.html Outdated
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your HTML code is not clean and properly aligned. Please use 2 spaces for indentation. Additionally, ensure that child elements are properly indented under their parent elements. Here's an example to help you:

Incorrect:

<!DOCTYPE html>
<html>
    <head>
        <title>Page Title</title>
    </head>
    <body>
        <h1>This is a Heading</h1>
        <p>This is a paragraph.</p>
    </body>
</html>

Correct:

<!DOCTYPE html>
<html>
  <head>
    <title>Page Title</title>
  </head>
  <body>
    <h1>This is a Heading</h1>
    <p>This is a paragraph.</p>
  </body>
</html>

Rule: Each child element should be indented 2 spaces under its parent element for better readability and maintainability.
Hint: Go to the VSCode bottom right corner, you can see "Spaces: 4" (or a similar indicator). Click on that, then click on "Indent Using Spaces" and select 2. You can also use the gray color column lines to help you know where your parent and child elements should be.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Add your project details in all sections, and remove those parts that you don't know or your project does not have it.

@latifa-wakili
Copy link
Owner Author

@ahzamir sir I update my project after your feedback but i couldnt add demo on readme file

Copy link

@ahzamir ahzamir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@latifa-wakili

  • Still your code has some issues try to get help from your partner to solve the issues.

README.md Outdated
## Demo 📸


![Demo](c:\Users\DELL\OneDrive\Pictures\Screenshots\Screenshot (8).png)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • You have used an external folder link for your screenshot which is wrong. First You have to add your image to your project folder then use the internal image link from inside of your project.

index.html Outdated
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Still, your code has lots of spacing issues, ask your partner to help you with that and learn how to solve it.

  • Your HTML code is not clean and properly aligned. Please use 2 spaces for indentation instead of 1-3-4 or no spaces. Additionally, ensure that child elements are properly indented under their parent elements. Here's an example to help you:

Incorrect:

<!DOCTYPE html>
<html>
    <head>
        <title>Page Title</title>
    </head>
    <body>
        <h1>This is a Heading</h1>
        <p>This is a paragraph.</p>
    </body>
</html>

Correct:

<!DOCTYPE html>
<html>
  <head>
    <title>Page Title</title>
  </head>
  <body>
    <h1>This is a Heading</h1>
    <p>This is a paragraph.</p>
  </body>
</html>

Rule: Each child element should be indented 2 spaces under its parent element for better readability and maintainability.
Hint: Go to the VSCode bottom right corner, you can see "Spaces: 4" (or a similar indicator). Click on that, then click on "Indent Using Spaces" and select 2. You can also use the gray color column lines to help you know where your parent and child elements should be.

@latifa-wakili
Copy link
Owner Author

@ahzamir I cleaned my html codes by helping my partner (Zainab behzad) and add a photo of my project on demo part of README.MD file.

for doing it late i am sorry i was on the way of ghor to kabul

README.md Outdated
Comment on lines 11 to 32

```html
<!-- </header>
<li class="li">Writing into an alert box, using window.alert().</li>
<li class="li">Writing into the browser console, using console.log().</li> -->
```

```css
/*
.li {
font-family: Arial, Helvetica, sans-serif;
}
*/
```

```javascript
// class Car {
constructor(name, year) {
this.name = name;
this.year = year;
}You can also include JavaScript code snippets.
```
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Remove these part

README.md Outdated
Provide step-by-step instructions on how to install and set up your project. Include any dependencies or prerequisites that need to be installed.

```bash
# git.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Add this code here (# git clone [email protected]:latifa-wakili/Documentation-page.git)

README.md Outdated
```

```bash
# github.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • And add this one here (# cd Documentation-page)

README.md Outdated
Comment on lines 56 to 59
[email protected]:latifa-wakili/Documentation-page.git cd Documentation-page
```bash
# vscode.
```
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Remove this after you moved it up

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ahzamir sir I did steps you said about my readme file please re review it now

Copy link

@ahzamir ahzamir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @latifa-wakili 🙋‍♀️,

Excellent work! 💯 You have done a great job implementing all the project requirements. 🥳 Your feature is complete! Congratulations!!!🎊

  • [REQUIRED] Share your project on this GROUP, add a simple Proud Moment text and a screenshot of your project then besides that add your project link at the end of the text as a GitHub Source code reference and post.

  • Share your Project on your LinkedIn account and add a proud moment text on it with a screenshot.

  • Well Done great design Implemented. 🎯🎉👍

Status: Approved ✅

There is nothing to say other than to merge your branch. 🎉🎯✅👍😊🥳

GreatJobThumbsUpGIF

Highlights 🌞

🎉 Great Design Implemented
✔️ Created a professional Repo (You created a repository with your project name)
✔️ Correct use of Gitflow (You created the development branch and made it your default branch, then created and committed your work on your feature branch)
✔️ Commit messages are meaningful
✔️ Setup the linters correctly (You added the correct linters config into your project according to the language you used on your code)
✔️ No linter errors (All linters checks have been passed 🟢)
✔️ You have followed the Documentation Page project task and committed using the command line
✔️ Created the pull request (From your feature branch to the development branch you created a pull request and submitted the pull request link for review)
✔️ Good PR description (You added a meaningful description to your PR about your work and the features you added on this pull request)
✔️Your code is clean
✔️Your repo has a professional README.md

Cheers 🥂 and Happy coding!!! 👯 Feel free to leave any questions or comments in the PR thread if something is not 100% clear. Please, remember to tag me @ahzamir in your question so I can receive the notification.

@latifa-wakili latifa-wakili merged commit fdb616a into main Jun 2, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants