technical-documentation
🖥️

Technical Document

Built with

html5
css
javascript

Overview

For the fourth project of Freecodecamp responsive Design I built a technical documentation page Landing. I decided to mix the style from MDN Web Docs (https://developer.mozilla.org/en-US/docs/) page and react.js documentation. Keep it clean and minimal. The focus was on applying Visual Designs with a combination of typography, color theory, graphics, animation, page layout, and to deliver my message. To apply accessibility to include people with visual, auditory, mobility, or cognitive disabilities. Then make a responsive web design that works and looks great on all devices.

Goals

The goal was to build a CodePen.io app that is functionally similar to this: https://codepen.io/freeCodeCamp/full/NdrKKL. I used HTML and CSS to build a responsive design that looks great on all layouts.

Lessons Learned

What I learnt during this project was how to style coding elements inside the documentation

technical-documentation-mobile
Fig.1 - Mobile View of App

Process

I followed the freecodecamp user story:

  • User Story #1: I can see a main element with a corresponding id="main-doc", which contains the page's main content (technical documentation).
  • User Story #2: Within the #main-doc element, I can see several section elements, each with a class of main-section. There should be a minimum of 5.
  • User Story #3: The first element within each .main-section should be a header element which contains text that describes the topic of that section.
  • User Story #4: Each section element with the class of main-section should also have an id that corresponds with the text of each header contained within it. Any spaces should be replaced with underscores (e.g. The section that contains the header "JavaScript and Java" should have a corresponding id="JavaScript_and_Java").
  • User Story #5: The .main-section elements should contain at least 10 p elements total (not each).
  • User Story #6: The .main-section elements should contain at least 5 code elements total (not each).
  • User Story #7: The .main-section elements should contain at least 5 li items total (not each).
  • User Story #8: I can see a nav element with a corresponding id="navbar".
  • User Story #9: The navbar element should contain one header element which contains text that describes the topic of the technical documentation.
  • User Story #10: Additionally, the navbar should contain link (a) elements with the class of nav-link. There should be one for every element with the class main-section.
  • User Story #11: The header element in the navbar must come before any link (a) elements in the navbar.
  • User Story #12: Each element with the class of nav-link should contain text that corresponds to the header text within each section (e.g. if you have a "Hello world" section/header, your navbar should have an element which contains the text "Hello world").
  • User Story #13: When I click on a navbar element, the page should navigate to the corresponding section of the main-doc element (e.g. If I click on a nav-link element that contains the text "Hello world", the page navigates to a section element that has that id and contains the corresponding header.
  • User Story #14: On regular sized devices (laptops, desktops), the element with id="navbar" should be shown on the left side of the screen and should always be visible to the user.
  • User Story #15: My Technical Documentation page should use at least one media query.
  • Then decided on the best layout of the content and made a design in figma. Finally I scaffolded the HTML and started to style it then finished with adding SEO

    technical-documentation-tablet
    Fig.2 - Tablet View of App