Skip to content

Conversation

jingting1412
Copy link
Contributor

@jingting1412 jingting1412 commented Feb 15, 2024

What is the purpose of this pull request?

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

Overview of changes:
Implements the changes as discussed in issue #2091, more specifically I'm implementing the points as summarised here by @kaixin-hc

Anything you'd like to highlight/discuss:
Open to any discussion regarding how best to structure/implement the syntax reference page.

Testing instructions:
Load the UG and ensure changes are according to what is discussed.

Proposed commit message: (wrap lines at 72 characters)
Combine syntax cheat sheet and full syntax reference pages


Checklist: ☑️

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

Copy link

codecov bot commented Feb 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.92%. Comparing base (9336559) to head (027e707).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2426   +/-   ##
=======================================
  Coverage   48.92%   48.92%           
=======================================
  Files         124      124           
  Lines        5245     5245           
  Branches     1110     1110           
=======================================
  Hits         2566     2566           
  Misses       2371     2371           
  Partials      308      308           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jingting1412 jingting1412 changed the title [WIP] Combining syntax cheat sheet and full syntax reference pages Combining syntax cheat sheet and full syntax reference pages Feb 26, 2024
@jingting1412 jingting1412 marked this pull request as ready for review February 26, 2024 15:27
Copy link
Contributor

@kaixin-hc kaixin-hc left a comment

Choose a reason for hiding this comment

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

page is looking great! here are a couple of things to check on


{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}
Copy link
Contributor

Choose a reason for hiding this comment

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

Screenshot 2024-02-29 at 3 52 03 PM Something changed here deletes the content of this page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes sorry for my mistake, I've since updated the code!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

On an unrelated note, I think this page can benefit from a site nav, maybe I can open an issue to quickly add it in?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, new issue and minor change sounds good. While you're at it, I think a tip box at the top (similar to the syntax reference page) wouldn't hurt


<include src="codeAndOutput.md" boilerplate >
<include src="codeAndOutput.md" boilerplate >
Copy link
Contributor

Choose a reason for hiding this comment

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

unrelated formatting change?

Copy link
Contributor

@kaixin-hc kaixin-hc left a comment

Choose a reason for hiding this comment

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

LGTM! thanks for reworking this, I think it will be nice from a user perspective ❤️

@kaixin-hc kaixin-hc merged commit a44bdaa into MarkBind:master Mar 4, 2024
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.

2 participants