<ol><li>The PR preview is generated by netlify/markbind-master/deploy-preview.</li> <li>You can find the link to the PR preview in the checks section of the PR. <span class="image-wrapper"><img src="/devdocs/images/bootcamp/live_preview.png" alt="PR Checks Section" width="920" height="" loading="eager" class="img-fluid rounded"><span class="image-caption"><!--[--><!--]--></span></span></li> <li>Open the link to the PR preview and ensure that your changes are reflected in the rendered site</li></ol></li> <li>Follow up with PR reviews and make changes as requested.</li></ol></div> <p>Since this is a hypothetical change, you do not need to raise a PR. You can refer to PR <a href="https://github.com/MarkBind/markbind/pull/1924">#1924</a> for an example.</p> <div class="alert box-container border-danger alert-border-left" style="" data-v-19514615><!--Icon and vertical divider for seamless header box--><!----><div class="header-and-body" data-v-19514615><!-- Header wrapper, not rendered if there is no header attribute --><!----><!-- Body wrapper --><div class="box-body-wrapper" data-v-19514615><!-- icon on the left, not shown if there is a header --><div class="icon-wrapper text-danger" style="" data-v-19514615><!--[--><i class="fas fa-flag" data-v-19514615></i><!--]--></div><!-- Icon -- content divider for seamless boxes without the header attribute --><!----><!-- Content wrapper --><div class="contents" style="" data-v-19514615><!--[--><p><strong>Checkpoint</strong></p> <p>For <span class="underline">actual</span> documentation changes, check that the following are true:</p> <ul class="contains-task-list"><li class="task-list-item enabled"><input class="task-list-item-checkbox" type="checkbox"> The PR template has been filled in</li> <li class="task-list-item enabled"><input class="task-list-item-checkbox" type="checkbox"> The PR preview is working</li></ul><!--]--></div><!-- dismiss button on the right, not shown if there is a header --><!----></div></div></div> <h2 id="summary">Summary<a class="fa fa-anchor" href="#summary" onclick="event.stopPropagation()"></a></h2> <p>In this task, you have learned how to make documentation changes to MarkBind!</p> <p>While documentation changes are not as exciting as code changes, they are still important. In particular, our documentation is generated by MarkBind itself, utilizing the same features that we are documenting. This means that our documentation is a great place to discover and analyze how MarkBind is used!</p> <p>Here are some additional tasks for you to try out:</p> <ul class="contains-task-list"><li class="task-list-item enabled"><input class="task-list-item-checkbox" type="checkbox"> Review a real documentation change (e.g <a href="https://github.com/MarkBind/markbind/issues/1772">issue #1772</a> was resolved in <a href="https://github.com/MarkBind/markbind/pull/1924">PR #1924</a> to improve the user guide)</li> <li class="task-list-item enabled"><input class="task-list-item-checkbox" type="checkbox"> Check if there are <a href="https://github.com/MarkBind/markbind/issues?q=is%3Aopen+label%3A%22a-Documentation+%F0%9F%93%9D%22+sort%3Aupdated-desc">existing issues</a> tagged with the <code class="hljs inline no-lang">a-Documentation</code> label
0 commit comments