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

Reorganise usingComponents page #1698

Merged
merged 6 commits into from
Dec 29, 2021

Conversation

ang-zeyu
Copy link
Contributor

@ang-zeyu ang-zeyu commented Dec 27, 2021

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • Others, please explain:

Overview of changes:

  • The usingComponents page is split into 6 different subsections.
  • Some small content edits (dropdowns.mbdf) are done to make the content flow better with the new organisation.
  • Old links to usingComponents.html are relinked as appropriate

Anything you'd like to highlight / discuss:

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)

Reorganize using components page


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

@ang-zeyu ang-zeyu requested review from damithc and jonahtanjz and removed request for damithc December 27, 2021 11:11
@ang-zeyu
Copy link
Contributor Author

Not a fan of overly long pages, wdyt @jonahtanjz @damithc

There is the page nav, but the scrollbar becomes intimidatingly small =(

@damithc
Copy link
Contributor

damithc commented Dec 27, 2021

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.

@ang-zeyu
Copy link
Contributor Author

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

Copy link
Contributor

@damithc damithc left a 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.

Copy link
Contributor

@jonahtanjz jonahtanjz left a comment

Choose a reason for hiding this comment

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

I think splitting them makes the components pages more organised and less cluttered. I'm fine with it as well :) The rest of the content looks good. Just 2 suggestions:

Should the previous page of Using HTML, JavaScript, CSS be Using Components -> Advanced instead?
Capture


<span id="overview" class="lead">

The image components here provide **convenient syntax & styling abstractions** on top of raw HTML and Markdown images.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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?

Copy link
Contributor Author

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.

Copy link
Contributor

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?

@ang-zeyu ang-zeyu mentioned this pull request Dec 28, 2021
9 tasks
Comment on lines 1 to 2
{% set title = "Diagram Components" %}
{% set filename = "diagrams" %}
Copy link
Contributor

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

Copy link
Contributor

@jonahtanjz jonahtanjz left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@jonahtanjz jonahtanjz added this to the 3.0.7 milestone Dec 29, 2021
@jonahtanjz jonahtanjz merged commit f78ed06 into MarkBind:master Dec 29, 2021
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