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

Home page of Docs website #11

Merged
merged 19 commits into from
Dec 25, 2024
Merged

Conversation

VanshikaSabharwal
Copy link
Contributor

What kind of change does this PR introduce?

bugfix, feature, refactoring

Issue Number:

Fixes #3

Did you add tests for your changes?

No

Snapshots/Videos:
Before:
Screenshot 2024-12-13 103440

After:
Screenshot 2024-12-17 154545
Screenshot 2024-12-17 154617

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Other information

Have you read the contributing guide?

Yes

Copy link

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests and there are no merge conflicts.

The process helps maintain accurate and well-formatted documentation and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

You have changed the content, which is out of scope of the issue. We need the page layout and page content to match the current site:

@VanshikaSabharwal
Copy link
Contributor Author

Yes just give me a minute i changes that to test if everything is working fine.

@palisadoes
Copy link
Contributor

These files must be removed. The content must be maintained as it currently exists

image

@VanshikaSabharwal
Copy link
Contributor Author

Yes Actually i added some dummy data. And i have removed it. @palisadoes

@palisadoes
Copy link
Contributor

Thanks,

However, you have changed the content. This is not in keeping with the original issue.

  1. The extra markdown files are still there. They must be removed.
    1. image
  2. The markdown from the existing site must be unchanged.

@VanshikaSabharwal
Copy link
Contributor Author

Yes @palisadoes I have reverted the changes.
Also i made changes to localhost:3000 as well to make the theme and colors similar.
Before : -

Screenshot 2024-12-14 094833

After : -

Screenshot 2024-12-18 110902
image
image
image
image

@VanshikaSabharwal
Copy link
Contributor Author

@palisadoes
All the tests have passed, and I’ve removed the unwanted content as requested. Can you please review and merge PR if everything is fine.

@palisadoes
Copy link
Contributor

Please make the dividing lines between the sections be in grey like this. You have blue currently.

image

@palisadoes
Copy link
Contributor

Can you make the home page mimic hasura.io. With the following modifications:

  1. A grey background
  2. Have the text box like the image below:
    image
  3. Make the blue match the closest one in the stylesheet
  4. Make the "Learn More" link go to the /docs page
  5. Remove this as it's not relevant to the site:
    image
  6. Make the footer background color match the grey background.
  7. Replace the docusaurus logo with the Palisadoes logo.

We need a clean site.

You can see something similar here:

https://hasura.io/

image

@VanshikaSabharwal
Copy link
Contributor Author

Yes @palisadoes i get it

@VanshikaSabharwal
Copy link
Contributor Author

image
image
Screenshot 2024-12-23 232312
Screenshot 2024-12-23 232353
Screenshot 2024-12-23 232412

For footer can you please tell me which one is good.

  1. Option 1
    image
  2. Option 2
    image

@VanshikaSabharwal
Copy link
Contributor Author

I have fixed side bar border to grey.
Screenshot 2024-12-23 233835

And added Talawa logo.
image

This test is failing because i have installed react-icons as we need it.
https://github.com/PalisadoesFoundation/developer-docs/actions/runs/12471103661/job/34807458008?pr=11

Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

Thanks.

  1. Use the color scheme from https://hasura.io/docs/2.0/remote-schemas/overview/ when in doubt about colors for light/dark mode
  2. Please remove this.
    image
  3. The text is unreadable in dark mode (See item 1)
    image
  4. On the home screen, use a grey background (#f3f4f6). Have a div like this instead:
    image
  5. The footer must use the grey (#f3f4f6) background. (See item 1 for footer text colors for this footer text)
    image
  6. These also need adjustments (See item 1)
    1. The highlighted menu option is not clearly visible.
    2. The lines between the options are not sufficiently subtle like in light mode.
    3. The text in the left nav bar is not sufficiently readable. The contrast is too low.
      image

@VanshikaSabharwal
Copy link
Contributor Author

Yes @palisadoes i am doing it

@palisadoes
Copy link
Contributor

Are you still working on this?

@VanshikaSabharwal
Copy link
Contributor Author

Yes @palisadoes i just have to commit changes. Everything is working fine

@VanshikaSabharwal
Copy link
Contributor Author

image
image
image
Is this fine now @palisadoes ?

@VanshikaSabharwal
Copy link
Contributor Author

The failing test is due to the fact that i installed react-icons, and we need it for styling icons.

@palisadoes
Copy link
Contributor

  1. Thanks. This is a good start. It is much, much better than before. I'll merge.
  2. I'll open another issue to fine tune the color scheme.

@palisadoes palisadoes merged commit e7dc6a3 into PalisadoesFoundation:main Dec 25, 2024
3 of 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.

Create a developer.palisadoes.org website
2 participants