readme.md Template

Portfolio Landing Page Documentation

Student Name: [Your name]
Assignment: Web Authoring Assignment 1
Repository: [Link to your GitHub repository]
Live Site: [Link to your GitHub Pages deployment]

Instructions

This template guides you through documenting your completed portfolio landing page. Complete this file after you've finished your portfolio, or update it as you work.

1. Portfolio Overview

What is your portfolio and what does it do?

Your answer:
[Explain what your portfolio is and its purpose]

What makes your portfolio effective?

Your answer:
[Describe what makes your portfolio successful - 2-3 sentences]

2. Page Contents

Header Section

What appears in your header?
[Describe the header content and layout]

Introduction Section

What information did you include about yourself?
[Describe the content of your introduction]

Projects Section

How did you present the four ML projects?
[Describe your layout and content approach]

Where is navigation located and what does it include?
[Describe your navigation placement and links]

What appears in your footer?
[Describe footer content]

4. Technologies Used

Core Technologies

HTML version: [e.g., "HTML5"]

CSS version: [e.g., "CSS3"]

Development Tools

Text editor: [What you used to write code]

Browsers tested: [List all browsers you tested in]

Version control: [Git and GitHub]

Key HTML Elements

List the main HTML elements you used:

[Element, e.g., "header - for page header"]
[Element]

Key CSS Techniques

List the main CSS techniques you implemented:

[Technique, e.g., "Flexbox - for navigation layout"]
[Technique]

5. Viewing the Site

How to view locally

Step 1: Clone the repository

git clone [your-repository-url]

Step 2: Navigate to the project directory

cd [repository-name]

Step 3: Open in browser

Open index.html directly in your web browser

GitHub Pages URL

Live site: [Your full GitHub Pages URL]

7. Credits and Attributions

Resources Used

Images:

[Image filename: Source and attribution if not your own]

Fonts:

[Font name and source]

Code snippets or tutorials:

[Attribution for any code you adapted]

9. Learning Reflection

What did you learn about HTML?

[Write 2-3 paragraphs reflecting on your HTML learning]

What did you learn about CSS?

[Write 2-3 paragraphs reflecting on your CSS learning]

What did you learn about web development workflow?

[Write 2-3 paragraphs reflecting on workflow and process]

What would you do differently next time?

[Write 1-2 paragraphs on what you'd improve]

Documentation completed: [Date]

Portfolio status: [Complete/In progress]

Last updated: [Date of last significant update]

Assignment1_Readme_Template