Skip to content

[#1557] Migrate docs to use MarkBind V3 #1559

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.

Sign up for GitHub

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

Jump to bottom
Merged
dcshzj merged 12 commits into from
Aug 24, 2021
Merged

[#1557] Migrate docs to use MarkBind V3 #1559

dcshzj merged 12 commits into from
Aug 24, 2021

Conversation

@damithc
Copy link
Collaborator

@damithc damithc commented Jul 5, 2021 •
edited by dcshzj
Loading

Fixes #1557

Proposed commit message:

Migrate docs to use MarkBind V3

Our docs are not compatible with some of the breaking changes
introduced by MarkBind V3.

Let's migrate our docs to MarkBind V3 so that our website can use the
latest version of MarkBind.

@damithc damithc marked this pull request as ready for review July 5, 2021 19:14
@damithc
Copy link
Collaborator Author

damithc commented Jul 6, 2021

Ready for review.

@dcshzj
Copy link
Member

dcshzj commented Jul 6, 2021

Apologies @damithc, the DevOps guide will need to be migrated as well.

@damithc
Copy link
Collaborator Author

damithc commented Jul 6, 2021

Apologies @damithc, the DevOps guide will need to be migrated as well.

Done. Thanks for the heads up @dcshzj

@dcshzj dcshzj requested a review from a team July 9, 2021 14:01
dcshzj
dcshzj requested changes Jul 9, 2021
View reviewed changes
Copy link
Member

@dcshzj dcshzj left a comment

Choose a reason for hiding this comment

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

The sidebar top heading is also hidden by the yellow notice when at small viewports, as shown in this GIF (there is supposed to be a "USER GUIDE" heading):

chrome-capture (1)

docs/css/main.css
Comment on lines +114 to +116
footer {
margin-left: 60px;
}
Copy link
Member

@dcshzj dcshzj Jul 9, 2021

Choose a reason for hiding this comment

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

Is this intentional? It seems to cause a weird gap on smaller viewports.

image

Copy link
Collaborator Author

@damithc damithc Jul 10, 2021

Choose a reason for hiding this comment

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

This part of the css is generated by the makbind init command. I've raised this on their side.

@damithc damithc mentioned this pull request Jul 10, 2021
Closed
@damithc
Copy link
Collaborator Author

damithc commented Jul 10, 2021

Thanks for the review @dcshzj I've updated as per your comments.

@damithc
Copy link
Collaborator Author

damithc commented Jul 10, 2021

The sidebar top heading is also hidden by the yellow notice when at small viewports, as shown in this GIF (there is supposed to be a "USER GUIDE" heading):

I've raised this on MarkBind side.

@dcshzj
Copy link
Member

dcshzj commented Jul 15, 2021

I've raised this on MarkBind side.

Sorry @damithc, is this on MarkBind's issue tracker? I could not find a relevant issue posted.

@damithc
Copy link
Collaborator Author

damithc commented Jul 15, 2021

I've raised this on MarkBind side.

Sorry @damithc, is this on MarkBind's issue tracker? I could not find a relevant issue posted.

It's in their discussions page MarkBind/markbind#1631 (comment)

@github-actions
Copy link
Contributor

github-actions bot commented Aug 15, 2021

Hi,
We are going to mark this PR as stale because it has been inactive for the past 30 days.
If no further activity occurs within the following 7 days, it will be automatically closed so that others can take up the issue.
If you are still working on this PR, please make a follow-up commit within 7 days and leave a comment to remove the stale label.
Do let us know if you are stuck so that we can help you!'

@github-actions github-actions bot added the Stale label Aug 15, 2021
@damithc
Copy link
Collaborator Author

damithc commented Aug 15, 2021

@reposense/active-devs , remember to merge this PR. Go ahead and do further changes as necessary.

@github-actions github-actions bot removed the Stale label Aug 16, 2021
@dcshzj dcshzj self-requested a review August 22, 2021 07:28
dcshzj
dcshzj approved these changes Aug 22, 2021
View reviewed changes
Copy link
Member

@dcshzj dcshzj left a comment

Choose a reason for hiding this comment

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

LGTM! It is unlikely that the two issues raised will be resolved anytime soon, but it does not affect our documentation too significantly.

@dcshzj dcshzj requested a review from a team August 22, 2021 07:29
@dcshzj dcshzj changed the title Migrate docs to use MarkBind V3 [#1557] Migrate docs to use MarkBind V3 Aug 24, 2021
@dcshzj dcshzj merged commit c57128f into reposense:master Aug 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dcshzj dcshzj dcshzj approved these changes

@fzdy1914 fzdy1914 fzdy1914 approved these changes

Assignees

No one assigned

Labels

s.ToMerge

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update documentation website to use MarkBind v3

4 participants

@damithc @dcshzj @fzdy1914 @Tejas2805