Skip to content

Update DG to be consistent with default template#2288

Merged
tlylt merged 9 commits intoMarkBind:masterfrom
lhw-1:2225-update-devdocs
Apr 17, 2023
Merged

Update DG to be consistent with default template#2288
tlylt merged 9 commits intoMarkBind:masterfrom
lhw-1:2225-update-devdocs

Conversation

@lhw-1
Copy link
Contributor

@lhw-1 lhw-1 commented Apr 16, 2023

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:

Updates the Onboarding Bootcamp to be consistent with changes made in #2225. Mainly wording and image updates to the Developer Guide.

Anything you'd like to highlight/discuss:

As the pageNav of the frontmatter in the default template was changed from 2 to 4, I've modified the instructions to accommodate this change: instead of changing it from 2 to 1, the readers are now expected to try changing it from 4 to 5, which will show the sub-headings in the panel. I've also included a "before" image for this section to better highlight the differences. Following this, should we include a before vs after for all the relevant sections?

Also, after the removal of title from site.json in #2128, the title property is not generated by default, so I've tweaked the wording to be more suitable (and included a panel to the site.json page in the UG for reference).

While #2282 is related, I will not tackle it in this PR (for now) as it is possibly being tackled in another ongoing PR.

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)
Update DG to be consistent with default template


Checklist: ☑️

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

@lhw-1 lhw-1 marked this pull request as ready for review April 16, 2023 10:28
@lhw-1 lhw-1 requested a review from tlylt April 16, 2023 10:29
@tlylt tlylt added this to the v4.1.1 milestone Apr 17, 2023
@tlylt tlylt merged commit 37cc4a3 into MarkBind:master Apr 17, 2023
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