Technical Documentation Page - Build a Technical Documentation Page

What’s Happening: I’m trying to style my p elements to be a uniform block while adjusting for different screen sizes. Coupling this with the padding I’ve done to get everything where I want it I’m having trouble. Tried a couple of media queries and playing with the margins/padding and I’m just not getting what I want. Every time I get it looking nice and uniform it compresses with the window.

You’ll noticed a navbar in the top left that’s kept separate from my main content; I basically want similar padding on the other side. Not necessarily padding the CSS attribute, but padding in general. For now there’s no attempt at styling the p besides declaring it’s display and the media queries.

Code so far


<html lang="en">
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link rel="stylesheet" href="styles.css">
    <title>GitHub Hello World</title>
    <nav id="navbar">
    <header id="navhead"><b>In this article</b></header>
    <ul role="list">
      <li><a class="nav-link" href="#introduction">Introduction</a></li>
      <li><a class="nav-link" href="#create_a_repository">Create a repository</a></li>
      <li><a class="nav-link" href="#creating_a_branch">Creating a branch</a></li>
      <li><a class="nav-link" href="#making_and_committing_changes">Making and committing changes</a></li>
      <li><a class="nav-link" href="#opening_a_pull_request">Opening a pull request</a></li>
      <li><a class="nav-link" href="#merging_your_pull_request">Merging your pull request</a></li>
      <li><a class="nav-link" href="#next_steps">Next steps</a></li>
   <main id="main-doc">
       <figure id="doc-header">
         <h1>Hello World</h1>
         <figcaption>Follow this Hello World exercise to get started with GitHub.</figcaption>
     <section class="main-section" id="introduction">
         <header>Introduction</header> <!--resize header elements-->
         <p>GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.</p> 
         <p>This tutorial teaches you GitHub essentials like repositories, branches, commits, and pull requests. You'll create your own Hello World repository and learn GitHub's pull request workflow, a popular way to create and review code.</p>
         <p>In this quickstart guide, you will:</p>
         <ul role="list">
             <li>Create and use a repository</li>
             <li>Start and manage a new branch</li>
             <li>Make changes to a file and push them to GitHub as commits</li>
             <li>Open and merge a pull request</li>
         <p>To complete this tutorial, you need a <a href="">GitHub account</a> and Internet access. You don't need to know how to code, use the command line, or install Git (the version control software that GitHub is built on). If you have a question about any of the expressions used in this guide, head on over to the <a href="">glossary</a> to find out more about our terminology.</p>
         <section class="main-section" id="create_a_repository">
         <header>Create a repository</header>
         <p>A repository is usually used to organize a single project. Repositories can contain folders and files, images, videos, spreadsheets, and data sets -- anything your project needs. Often, repositories include a README file, a file with information about your project. README files are written in the plain text Markdown language. You can use this <a href="">cheat sheet</a> to get started with Markdown syntax. GitHub lets you add a README file at the same time you create your new repository. GitHub also offers other common options such as a license file, but you do not have to select any of them now.</p>
         <p>Your <code>hello-world</code> repository can be a place where you store ideas, resources, or even share and discuss things with others.</p>
         <ol role="list">
             <li>In the upper-right corner of any page, use the + drop-down menu, and select New repository.
                 <img src="" />
             <li>In the "Repository name" box, type <code>hello-world</code>.</li>
             <!--maybe redo the bold in CSS-->
             <li>In the "Description" box, type a short description.</li>
             <li>Select whether your repository will be <b>Public</b> or <b>Private</b>.</li>
             <li>Select <b>Add a README file</b>.</li>
             <li>Click <b>Create repository</b>.</li>
         <section class="main-section" id="creating_a_branch">
         <header>Creating a branch</header>
         <p>Branching lets you have different versions of a repository at one time.</p>
         <p>By default, your repository has one branch named <code>main</code> that is considered to be the definitive branch. You can create additional branches off of <code>main</code> in your repository. You can use branches to have different versions of a project at one time. This is helpful when you want to add new features to a project without changing the <code>main</code> source of code. The work done on different branches will not show up on the <code>main</code> branch until you merge it, which we will cover later in this guide. You can use branches to experiment and make edits before committing them to <code>main</code>.</p>
         <p>When you create a branch off the <code>main</code> branch, you're making a copy, or snapshot, of <code>main</code> as it was at that point in time. If someone else made changes to the <code>main</code> branch while you were working on your branch, you could pull in those updates.</p>
         <p>This diagram shows:</p>
         <ul role="list">
             <li>The <code>main</code> branch</li>
             <li>A new branch called <code>feature</code></li>
             <li>he journey that <code>feature</code> takes before it's merged into <code>main</code></li>
         <img src="" />
         <p>Have you ever saved different versions of a file? Something like:</p>
         <ul role="list">
         <p>Branches accomplish similar goals in GitHub repositories.</p>
         <p>Here at GitHub, our developers, writers, and designers use branches for keeping bug fixes and feature work separate from our <code>main</code> (production) branch. When a change is ready, they merge their branch into <code>main</code>.</p>
         <h3>Create a branch</h3>
         <ol role="list">
             <li>Click the Code tab of your <code>hello-world</code> repository.</li>
             <li>Above the file list, click the dropdown menu that says <b>main</b>.
                 <img src="" />
             <li>Type a branch name, <code>readme-edits</code>, into the text box.</li>
             <li>Click <b>Create branch: readme-edits from main.</b>
                 <img src="" />
         <p>Now you have two branches, <code>main</code> and <code>readme-edits</code>. Right now, they look exactly the same. Next you'll add changes to the new branch.</p>
         <section class="main-section" id="making_and_committing_changes">
         <header>Making and committing changes</header>
         <p>When you created a new branch in the previous step, GitHub brought you to the code page for your new <code>readme-edits</code> branch, which is a copy of <code>main</code>.</p>
         <p>You can make and save changes to the files in your repository. On GitHub, saved changes are called commits. Each commit has an associated commit message, which is a description explaining why a particular change was made. Commit messages capture the history of your changes so that other contributors can understand what you’ve done and why.</p>
             <li>Under the <code>readme-edits</code> branch you created, click the <i></i> file.</li>
             <li>To edit the file, click <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-pencil" aria-label="Edit file" role="img"><path d="M11.013 1.427a1.75 1.75 0 0 1 2.474 0l1.086 1.086a1.75 1.75 0 0 1 0 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 0 1-.927-.928l.929-3.25c.081-.286.235-.547.445-.758l8.61-8.61Zm.176 4.823L9.75 4.81l-6.286 6.287a.253.253 0 0 0-.064.108l-.558 1.953 1.953-.558a.253.253 0 0 0 .108-.064Zm1.238-3.763a.25.25 0 0 0-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 0 0 0-.354Z"></path></svg>.</li>
             <li>In the editor, write a bit about yourself. Try using different Markdown elements.</li>
             <li>In the "Commit changes" box, write a commit message that describes your changes.</li>
             <li>Click <b>Commit changes</b>.</li>
             <p>These changes will be made only to the README file on your <code>readme-edits</code> branch, so now this branch contains content that's different from <code>main</code>.</p>
         <section class="main-section" id="opening_a_pull_request">
         <header>Opening a pull request</header>
         <p>Now that you have changes in a branch off of <code>main</code>, you can open a pull request.</p>
         <p>Pull requests are the heart of collaboration on GitHub. When you open a pull request, you're proposing your changes and requesting that someone review and pull in your contribution and merge them into their branch. Pull requests show diffs, or differences, of the content from both branches. The changes, additions, and subtractions are shown in different colors.</p>
         <p>As soon as you make a commit, you can open a pull request and start a discussion, even before the code is finished.</p>
         <p>By using GitHub's <code>@mention</code> feature in your pull request message, you can ask for feedback from specific people or teams, whether they're down the hall or 10 time zones away.</p>
         <p>You can even open pull requests in your own repository and merge them yourself. It's a great way to learn the GitHub flow before working on larger projects.</p>
             <li>Click the <b>Pull requests</b> tab of your <code>hello-world</code> repository.</li>
             <li>Click <b>New pull request</b></li>
             <li>In the <b>Example Comparisons</b> box, select the branch you made, <code>readme-edits</code>, to compare with <code>main</code> (the original).</li>
             <li>Look over your changes in the diffs on the Compare page, make sure they're what you want to submit.
                 <img src=""/>
             <li>Click <b>Create pull request</b>.</li>
             <li>Give your pull request a title and write a brief description of your changes. You can include emojis and drag and drop images and gifs.</li>
             <li>Optionally, to the right of your title and description, click the <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-gear" aria-label="The Gear icon" role="img"><path d="M8 0a8.2 8.2 0 0 1 .701.031C9.444.095 9.99.645 10.16 1.29l.288 1.107c. 1.392.021 1.218.315.675.111 1.422-.364 1.891l-.814.806c-.049.048-.098.147-. 0 .772-. 1.216.364 1.891a7.977 7.977 0 0 1-.704 1.217c-.428.61-1.176.807-1.82.63l-1.102-.302c-.067-.019-.177-.011-.3.071a5.909 5.909 0 0 1-.668.386c-.133.066-.194.158-.211.224l-.29 1.106c-.168.646-.715 1.196-1.458 1.26a8.006 8.006 0 0 1-1.402 0c-.743-.064-1.289-.614-1.458-1.26l-.289-1.106c-.018-.066-.079-.158-.212-.224a5.738 5.738 0 0 1-.668-.386c-.123-.082-.233-.09-.299-.071l-1.103.303c-.644.176-1.392-.021-1.82-.63a8.12 8.12 0 0 1-.704-1.218c-.315-.675-.111-1.422.363-1.891l.815-.806c.05-.048.098-.147.088-.294a6.214 6.214 0 0 1 0-.772c.01-.147-.038-.246-.088-.294l-.815-.806C.635 6.045.431 5.298.746 4.623a7.92 7.92 0 0 1 .704-1.217c.428-.61 1.176-.807 1.82-.63l1.102.302c. 6.556.095 7.299.03 7.53.01 7.764 0 8 0Zm-.571 1.525c-.036.003-.108.036-.137.146l-.289 1.105c-.147.561-.549.967-.998 1.189-.173.086-.34.183-.5.29-.417.278-.97.423-1.529.27l-1.103-.303c-.109-.03-.175.016-.195.045-.22.312-.412.644-.573.99-.014.031-. 1.456a4.709 4.709 0 0 0 0 .582c.032.499-.119 1.05-.53 1.456l-.815.806c-.081.08-.073.159-. 1.113-.008 1.189l.289 1.105c. 6.6 0 0 0 1.142 0c.036-.003.108-.036.137-.146l.289-1.105c.147-.561.549-.967.998-1.189.173-.086.34-.183.5-.29.417-.278.97-.423 1.529-.27l1.103.303c.109.029.175-.016.195-.045.22-.313.411-.644.573-.99.014-.031.021-.11-.059-.19l-.815-.806c-.411-.406-.562-.957-.53-1.456a4.709 4.709 0 0 0 0-.582c-.032-.499.119-1.05.53-1.456l.815-.806c.081-.08.073-.159.059-.19a6.464 6.464 0 0 0-.573-.989c-.02-.03-.085-.076-.195-.046l-1.102.303c-.56.153-1.113.008-1.53-.27a4.44 4.44 0 0 0-.501-.29c-.447-.222-.85-.629-.997-1.189l-.289-1.105c-.029-.11-.101-.143-.137-.146a6.6 6.6 0 0 0-1.142 0ZM11 8a3 3 0 1 1-6 0 3 3 0 0 1 6 0ZM9.5 8a1.5 1.5 0 1 0-3.001.001A1.5 1.5 0 0 0 9.5 8Z"></path></svg> next to <b>Reviewers</b>. <b>Assignees</b>, <b>Labels</b>, <b>Projects</b>, or <b>Milestone</b> to add any of these options to your pull request. You do not need to add any yet, but these options offer different ways to collaborate using pull requests. For more information, see <a href="">"About pull requests</a>."</li>
             <li>Click <b>Create pull request</b>.</li>
         <p>Your collaborators can now review your edits and make suggestions.</p>
         <section class="main-section" id="merging_your_pull_request">
         <header>Merging your pull request</header>
         <p>In this final step, you will merge your <code>readme-edits</code> branch into the <code>main</code> branch. After you merge your pull request, the changes on your <code>readme-edits</code> branch will be incorporated into <code>main</code>.</p>
         <p>Sometimes, a pull request may introduce changes to code that conflict with the existing code on <code>main</code>. If there are any conflicts, GitHub will alert you about the conflicting code and prevent merging until the conflicts are resolved. You can make a commit that resolves the conflicts or use comments in the pull request to discuss the conflicts with your team members.</p>
         <p>In this walk-through, you should not have any conflicts, so you are ready to merge your branch into the main branch.</p>
             <li>At the bottom of the pull request, click <b>Merge pull request</b> to merge the changes into <code>main</code>.</li>
             <li>Click <b>Confirm merge</b>. You will receive a message that the request was successfully merged and the request was closed.</li>
             <li>Click <b>Delete branch</b>. Now that your pull request is merged and your changes are on <code>main</code>, you can safely delete the <code>readme-edits</code> branch. If you want to make more changes to your project, you can always create a new branch and repeat this process.</li>
         <section class="main-section" id="next_steps">
         <header>Next steps</header>
         <p>By completing this tutorial, you've learned to create a project and make a pull request on GitHub.</p>
         <p>Here's what you accomplished in this tutorial:</p>
             <li>Created an open source repository</li>
             <li>Started and managed a new branch</li>
             <li>Changed a file and committed those changes to GitHub</li>
             <li>Opened and merged a pull request</li>
         <p>Take a look at your GitHub profile and you'll see your work reflected on your contribution graph.</p>
         <p>For more information about the power of branches and pull requests, see "<a href="">GitHub flow</a>." For more information about getting started with GitHub, see the other guides in the <a href="">getting started quickstart</a>.</p>


    box-sizing: border-box;
    /*trying this out as my default box-sizing*/
    /*will need rules for ::before and ::after but they aren't used here*/
  html {
    font-size: 62.5%;
    /*changes root font size so that 1rem=10px.Just so I can do the math easier in my head, since I'm told using rem units is best practice*/
    -webkit-text-size-adjust: none;
    text-size-adjust: none;
    /*The two lines above are so web browser algorithms don't resize my text on mobile. First line for iOS, second for "everyone" else*/
  body {
    font-size: 1.6rem;
    /*resizes all the text back to default 16px for now*/
    font-family: -apple-system, BlinkMacSystemFont, Segoe UI,
      Noto Sans, Helvetica, Arial, sans-serif, Apple Color Emoji,
      Segoe UI Emoji;
    background-color: #0d1117;
    color: #e6edf3;
  img {
    display: block;
    max-width: 100%;
    /*lets containers CONTAIN their images*/
  ol:not(article ol),
  ul:not(article ul) {
    list-style: none;
    /*Add 'role="list" to elements for screen reading, list-style=none; disables on some browsers. This is just a default placeholder, but good to note anyway. */
    padding: 2rem;
  a {
    text-underline-position: under;
    /* lowers underline, better readibility */
    text-decoration-thickness: 7;
    /* thickness as a % of the font size */
  main {
    display: block;
    padding-left: 30rem;
    padding-right: 10rem;
    overflow: auto;
  main a {
    color: #218bff;
  #navbar {
    position: fixed;
    top: 0;
    left: 0;
    color: #e6edf3;
  #navbar ul {
    margin: 0;
    padding: 0.5rem;
  #navbar li {
    display: flexbox;
    margin-right: 2rem;
    padding: 0.2rem;
  #navhead {
    padding-bottom: 1rem;

  #navbar a {
    text-decoration: none;
    color: inherit;
    background-color: transparent; 

#navbar a:hover {
  background-color: rgba(177, 186, 196, 0.08);
  border-radius: 0.8rem;
  padding: 0.3rem;
  padding-left: 0.6rem;
  padding-right: 0.6rem;

li, li:img {
  padding: 0.2rem;
  figure {
    padding-bottom: 1.5rem;
    margin-left: 1rem;
  figcaption {
    display: inherit;
    margin-top: -2rem

  p {
    display: block;

  @media only screen and (max-width: 600px) {
  p {
    font-size: 1.6rem;
    margin-bottom: 1em;

@media only screen and (min-width: 601px) and (max-width: 1024px) {
  p {
    font-size: 1.8rem;
    margin-bottom: 1.5em;

@media only screen and (min-width: 1025px) {
  p {
    font-size: 2rem;
    margin-bottom: 2em;

Browser information:

User Agent is: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/ Safari/537.36

Challenge: Technical Documentation Page - Build a Technical Documentation Page

Link to the challenge:

It’s worth noting this project is a recreation of a section of the Github Quickstart guide; so for an idea of what I mean: Hello World - GitHub Docs

I don’t know if I quite understand what it is your trying to do :confused:

A great trick to use when working out padding, is to put a border: 1px solid green on your HTML element

Browsers often put default padding onto elements. you can neutralize them.

Before styles:

* {
    border: 1px solid green;
    box-sizing: border-box;
body, figure, p, h1, h2, h3  {
    margin: 0px;
ul {
    margin: 0px;
    list-style: none;
    padding: 0px;

After styles:

Basically, as you can see from the GitHub link (let’s call it my model) as you resize the page the content adjusts accordingly. Make it small enough and the navbar will even adjust (it’s also worth noting that the model’s version has the navbar on the right side of the page, but it’s a requirement of the project to have mine on the left).

The goal I set for myself here was to create a page in the same vein as the original; obviously JS is involved in the actual doc so there’s only so much I can do here but I thought it a good goal. So I’m trying to style my p in a very similar way, while making sure the only thing I take directly from the model are things like the images, font-family and color choices.

I also ramble and struggle to explain myself when frustrated, which I very much was when I first posted. Might still be doing some of that now. I’ll definitely take your border trick idea into account when I code later this afternoon/evening and update when I’m done. Hope I managed to clarify some!

Okay I think I thought of a better way to phrase it. I want to contain everything in main as a more uniform block, similar to the styling from the model, and I’m struggling to do that in a way that doesn’t result in the text being smushed when the window changes size. I thought I had media queries in place to account for that but I think I’m missing something.

For now I’m letting it percolate while I focus on other parts of the project. Neuro spacing effect is real.

I think using another site as inspiration is a great thing to do :smiley:

have you considered using your media quires to change the font size?

smaller screens can ‘smush’ things :confused:
if you use em units for padding and margins you can have the whole page scale down a little with the font.

you can get a sense of what it would look like on mobile using ‘inspect’ tools

Honestly that’s a great shout. After taking the weekend though, I remembered breadth vs. depth and pulled back my goal of trying to imitate it so closely. I could stick with it and figure it out; I’d probably benefit from it.

But I think in this case, when I look at what the project asked for, I’m done. My short term goal is to finish Responsive Web Design by the end of May, can’t hyperfocus on one learning project. Your border trick is what let me work everything out, gunna mark that as our solution.

Thanks for talking things out with me, very helpful. :heart:

1 Like

This topic was automatically closed 182 days after the last reply. New replies are no longer allowed.