Update documentation and modify project links for clarity
This commit is contained in:
parent
9f29e35e03
commit
63df10bb0e
|
|
@ -1,7 +1,5 @@
|
|||
# 📖 Documentation
|
||||
|
||||
This document provides instructions on how to set up, run, and understand the project structure.
|
||||
|
||||
## Project Structure
|
||||
The project follows a standard Spring Boot application structure:
|
||||
- `src/main/java/com/example/Portfolio`: Root package.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
package com.example.Portfolio.Controllers;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Controller;
|
||||
import org.springframework.ui.Model;
|
||||
|
|
@ -23,8 +22,6 @@ public class ProjectController {
|
|||
//navbar links
|
||||
model.addAttribute("links", List.of(
|
||||
new Link("Overview", "#project-overview"),
|
||||
new Link("Documentation", "#documentation"),
|
||||
new Link("Roadmap", "#future-plans"),
|
||||
new Link("Demo-Vid", "#demo-vid")
|
||||
));
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ public class ResumeController {
|
|||
""",
|
||||
List.of(
|
||||
new SkillGroup("Languages", "Java, Python, MySQL, HTML & CSS"),
|
||||
new SkillGroup("Tools", "Spring Boot, HTMX, Kubernetes"),
|
||||
new SkillGroup("Tools", "Spring Boot, HTMX"),
|
||||
new SkillGroup("Soft Skills",
|
||||
"Communication, Teamwork, Problem-Solving, Adaptability")),
|
||||
List.of(
|
||||
|
|
|
|||
|
|
@ -22,12 +22,13 @@
|
|||
<span class="project-badge">Project Case Study</span>
|
||||
<h1 class="display-4 fw-bold mt-2" th:text="${project.name}">Project Name</h1>
|
||||
<p class="lead text-muted" th:text="${project.description}">Short description.</p>
|
||||
|
||||
|
||||
<div class="d-flex gap-3 mt-4">
|
||||
<!-- <a th:href="${project.githubUrl}" target="_blank" class="btn btn-dark px-4 py-2 rounded-pill">
|
||||
<i class="bi bi-github me-2"></i> GitHub
|
||||
</a> -->
|
||||
<a th:if="${project.liveUrl != null}" th:href="${project.liveUrl}" target="_blank" class="btn btn-outline-primary px-4 py-2 rounded-pill">
|
||||
<a th:href="${project.githubUrl}" target="_blank" class="btn btn-dark px-4 py-2 rounded-pill">
|
||||
<i class="bi bi-git me-2"></i> Gitea
|
||||
</a>
|
||||
<a th:if="${project.liveUrl != null}" th:href="${project.liveUrl}" target="_blank"
|
||||
class="btn btn-outline-primary px-4 py-2 rounded-pill">
|
||||
<i class="bi bi-globe me-2"></i> Live Demo
|
||||
</a>
|
||||
</div>
|
||||
|
|
@ -40,7 +41,9 @@
|
|||
<div class="container">
|
||||
<div class="browser-frame">
|
||||
<div class="browser-bar">
|
||||
<div class="dot"></div><div class="dot"></div><div class="dot"></div>
|
||||
<div class="dot"></div>
|
||||
<div class="dot"></div>
|
||||
<div class="dot"></div>
|
||||
</div>
|
||||
<div id="projectCarousel" class="carousel slide" data-bs-ride="carousel">
|
||||
<div class="carousel-inner">
|
||||
|
|
@ -49,10 +52,12 @@
|
|||
<img th:src="${img}" class="d-block w-100" alt="Screenshot">
|
||||
</div>
|
||||
</div>
|
||||
<button class="carousel-control-prev" type="button" data-bs-target="#projectCarousel" data-bs-slide="prev">
|
||||
<button class="carousel-control-prev" type="button" data-bs-target="#projectCarousel"
|
||||
data-bs-slide="prev">
|
||||
<span class="carousel-control-prev-icon"></span>
|
||||
</button>
|
||||
<button class="carousel-control-next" type="button" data-bs-target="#projectCarousel" data-bs-slide="next">
|
||||
<button class="carousel-control-next" type="button" data-bs-target="#projectCarousel"
|
||||
data-bs-slide="next">
|
||||
<span class="carousel-control-next-icon"></span>
|
||||
</button>
|
||||
</div>
|
||||
|
|
@ -60,20 +65,24 @@
|
|||
</div>
|
||||
</section>
|
||||
|
||||
<section class="py-5">
|
||||
<section class="py-5" id="project-overview">
|
||||
<div class="container">
|
||||
<ul class="nav nav-pills mb-4 gap-2 justify-content-center" id="projectTab" role="tablist">
|
||||
<li class="nav-item" role="presentation">
|
||||
<button class="nav-link active" id="overview-tab" data-bs-toggle="pill" data-bs-target="#overview" type="button" role="tab">Overview</button>
|
||||
<button class="nav-link active" id="overview-tab" data-bs-toggle="pill" data-bs-target="#overview"
|
||||
type="button" role="tab">Overview</button>
|
||||
</li>
|
||||
<li class="nav-item" role="presentation">
|
||||
<button class="nav-link" id="stack-tab" data-bs-toggle="pill" data-bs-target="#stack" type="button" role="tab">Tech Stack</button>
|
||||
<button class="nav-link" id="stack-tab" data-bs-toggle="pill" data-bs-target="#stack" type="button"
|
||||
role="tab">Tech Stack</button>
|
||||
</li>
|
||||
<li class="nav-item" role="presentation" th:if="${project.documentationHtml != null}">
|
||||
<button class="nav-link" id="docs-tab" data-bs-toggle="pill" data-bs-target="#docs" type="button" role="tab">Documentation</button>
|
||||
<button class="nav-link" id="docs-tab" data-bs-toggle="pill" data-bs-target="#docs" type="button"
|
||||
role="tab">Documentation</button>
|
||||
</li>
|
||||
<li class="nav-item" role="presentation" th:if="${project.futureHtml != null}">
|
||||
<button class="nav-link" id="future-tab" data-bs-toggle="pill" data-bs-target="#future" type="button" role="tab">Future Plans</button>
|
||||
<button class="nav-link" id="future-tab" data-bs-toggle="pill" data-bs-target="#future"
|
||||
type="button" role="tab">Future Plans</button>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -88,12 +97,14 @@
|
|||
<div class="stack-content" th:utext="${project.stackHtml}"></div>
|
||||
</div>
|
||||
|
||||
<div class="tab-pane fade" id="docs" role="tabpanel" aria-labelledby="docs-tab" th:if="${project.documentationHtml != null}">
|
||||
<div class="tab-pane fade" id="docs" role="tabpanel" aria-labelledby="docs-tab"
|
||||
th:if="${project.documentationHtml != null}">
|
||||
<h3 class="fw-bold mb-4">Technical Documentation</h3>
|
||||
<div class="lh-lg" th:utext="${project.documentationHtml}"></div>
|
||||
</div>
|
||||
|
||||
<div class="tab-pane fade" id="future" role="tabpanel" aria-labelledby="future-tab" th:if="${project.futureHtml != null}">
|
||||
<div class="tab-pane fade" id="future" role="tabpanel" aria-labelledby="future-tab"
|
||||
th:if="${project.futureHtml != null}">
|
||||
<h3 class="fw-bold mb-4">The Roadmap</h3>
|
||||
<div class="lh-lg" th:utext="${project.futureHtml}"></div>
|
||||
</div>
|
||||
|
|
@ -122,4 +133,5 @@
|
|||
<div th:replace="~{fragments/footer :: footer}"></div>
|
||||
<script th:src="@{/assets/js/bootstrap.bundle.min.js}"></script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
</nav>
|
||||
|
||||
<header>
|
||||
<h1 th:text="|${resume.firstName} ${resume.lastName}|">DANIEL WILSON</h1>
|
||||
<h1 th:text="|${resume.firstName} ${resume.lastName}|">Kiyan Mckop</h1>
|
||||
<div class="subtitle" th:text="${resume.jobTitle}">SOFTWARE ENGINEER</div>
|
||||
|
||||
<div class="contact-info">
|
||||
|
|
|
|||
Loading…
Reference in New Issue