-
Notifications
You must be signed in to change notification settings - Fork 124
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
Reorganise usingComponents page #1698
Conversation
Not a fan of overly long pages, wdyt @jonahtanjz @damithc There is the page nav, but the scrollbar becomes intimidatingly small =( |
I'm OK with the splitting. The cost is that the question 'what components are there?' becomes harder to answer. I guess it is not a major issue. We can always add the full list to the 'Using Components' page later. |
👍, we could do some organising of the full syntax reference (e.g. markdown / components / others -> then alphabetical sort) for this as well |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No objections to splitting the page. Did not do a detailed review of the content though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
<span id="overview" class="lead"> | ||
|
||
The image components here provide **convenient syntax & styling abstractions** on top of raw HTML and Markdown images. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The image components here provide **convenient syntax & styling abstractions** on top of raw HTML and Markdown images. | |
The diagram components here provide **convenient syntax & styling abstractions** on top of raw HTML and Markdown images. |
Should we change this to diagram so that it is consistent with the title?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for looking through this!
Should the previous page of Using HTML, JavaScript, CSS be Using Components -> Advanced instead?
Fixed.
Should we change this to diagram so that it is consistent with the title?
Indeed, I actually meant to change the title to Image & Diagram Components
instead.
I'm not sure if there's a better way of organising images and diagrams as well or if this is fine; On one hand they're slightly unrelated, on the other hand adding one more subpage makes the site nav seem a little too long.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if there's a better way of organising images and diagrams as well or if this is fine; On one hand they're slightly unrelated, on the other hand adding one more subpage makes the site nav seem a little too long.
I think this is fine for now since the section on diagrams is quite small. Once we introduce more ways of generating diagrams then we can consider splitting them up?
{% set title = "Diagram Components" %} | ||
{% set filename = "diagrams" %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we also change the site title and filename to include the Image
part as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
What is the purpose of this pull request?
Overview of changes:
usingComponents.html
are relinked as appropriateAnything you'd like to highlight / discuss:
:expanded:
on the submenu for now, due to [cs2103 website] Some site-nav items are not highlighted when open #1615. Not sure if we should leave it expanded or not since there's 6 items once its fixed thoughTesting instructions:
Proposed commit message: (wrap lines at 72 characters)
Reorganize using components page
Checklist: ☑️