Skip to content

Add LLVM.org website redesign project introduction blog post #189

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

Conversation

Chaitanya-Shahare
Copy link
Contributor

  • LLVM.org website redesign project introduction blog post
  • With personal introduction (Chaitanya Shahare)

- LLVM.org website redesign project introduction blog post
- With personal introduction (Chaitanya Shahare)
@vgvassilev vgvassilev requested a review from davidlange6 May 11, 2024 13:07
@vgvassilev
Copy link
Contributor

@QuillPusher, can you also take a look?

@QuillPusher
Copy link
Contributor

@QuillPusher, can you also take a look?

Looks good 😎
I like the approach mentioned in "3. Interactive Design Process" step, since usability is a major roadblock with the LLVM website, and engaging with the community will perhaps be the most time-consuming part of the process, but a necessary step, since taking the community in confidence will help clear any other impediments.

@Chaitanya-Shahare Following are some points that we discussed earlier that may be helpful in your Site Audit:

  • Sub-Sites: Many of the sections/sub-sites have a completely different UI/UX (e.g., main, clang, lists, foundation, circt, lnt, and docs). Sub-sites are divided into 8 separate repos and use different technologies including Hugo, Jekyll, etc.
  • Navigation: On-page navigation is inconsistent and confusing. Cross-sub-site navigation is inconsistent, unintuitive, and sometimes non-existent. Important subsections often depend on static links within (seemingly random) pages. Multi-word menu items are center-aligned and flow out of margins.
  • Pages: Many large write-ups lack pagination, section boundaries, etc., making them seem more intimidating than they really are. Several placeholder pages re-route to 3rd party services, adding bloat and inconsistency.
  • Search: Search options are placed in unintuitive locations, like the bottom of the side panel, or from static links to redundant pages. Some pages have no search options at all. With multiple sections of the website hosted in separate projects/repos, cross-sub-site search doesn't seem possible.
  • Contribution Guide: It should also include a more descriptive Contribution Guide (example) to help novice contributors, as well as to help maintain a coherent site structure.

@Chaitanya-Shahare
Copy link
Contributor Author

Should I address these points in the blog post?

Answering some of the points you discussed:

  • Sub-sites: To make the work reusable I'm planning to have the complete UI part as a HUGO theme, so whenever the sub-sites need to be updated, we can just use the same theme, which will give a consistent experience.

  • Navigation: Enhancing the site's navigation is one of the primary goals of the project, I'll be sure to give this a priority in the site audit.

  • Contribution Guide: As the site's content need's a revamp as well, this is also a high priority so contributors can easily update the content.

For the scope of this project, I don't think we are focusing on the sub-sites and documentation site.

The following is the site map that this project will focus on, to the best of my knowledge. Excluding the pink boxes

image

@QuillPusher
Copy link
Contributor

Should I address these points in the blog post?

Yeah, I think mentioning any points you plan to include in your timeline may help gather some community feedback before putting serious effort into it

For the scope of this project, I don't think we are focusing on the sub-sites and documentation site.

I can understand that the scope (yellow boxes) for this activity is already big enough, so this is a good place to start

@vgvassilev
Copy link
Contributor

Hi @QuillPusher and @Chaitanya-Shahare, is my understanding correct that this is ready to go?

@Chaitanya-Shahare
Copy link
Contributor Author

Hi @vgvassilev, I'll make some changes suggested by @QuillPusher, it will be done today.

@Chaitanya-Shahare
Copy link
Contributor Author

@vgvassilev The changes are done from my side.

@vgvassilev
Copy link
Contributor

Let's move forward then.

@vgvassilev vgvassilev merged commit 3721c2b into compiler-research:master May 16, 2024
1 check 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.

3 participants