Skip to content

Commit ba1da56

Browse files
committed
Add overview section and update project description in documentation
1 parent 7925e6f commit ba1da56

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

doc/contents/introduction.tex

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,3 +146,7 @@ \subsection{Building \& Running AstraKernel}
146146
\caption{AstraKernel booted in QEMU.}
147147
\label{fig:bootedKernel}
148148
\end{figure}
149+
150+
\subsection{Codebase's Overview}
151+
% TODO: Write a brief overview of the codebase structure.
152+
Coming soon...

doc/front/preface.tex

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ \section*{Preface}
3939
\url{https://github.com/sandbox-science/AstraKernel}
4040
\end{info}
4141

42-
\addcontentsline{toc}{section}{Resources}
42+
\addcontentsline{toc}{section}{About This Project}
43+
\section*{About This Project}
4344
\subsection*{Resources}
4445

4546
To guide my learning and support development of AstraKernel, I am using the following resources,
@@ -49,7 +50,6 @@ \subsection*{Resources}
4950
\item \textbf{The Little Book About OS Development} by Erik Helin and Adam Renberg
5051
\end{itemize}
5152

52-
\addcontentsline{toc}{section}{Acknowledgments \& Contributions}
5353
\subsection*{Acknowledgments \& Contributions}
5454

5555
AstraKernel is an open source project, and I encourage contributions from anyone
@@ -69,7 +69,6 @@ \subsection*{Acknowledgments \& Contributions}
6969
function as well as the documentation for it.
7070
\end{itemize}
7171

72-
\addcontentsline{toc}{section}{Disclaimer}
7372
\subsection*{Disclaimer}
7473

7574
AstraKernel is currently in its early stages of development and is not intended for production use.

doc/main.tex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,6 @@
1919
% % -----------------------------------------------------
2020
\input{contents/introduction}
2121
\input{contents/puts}
22+
\input{contents/datetime}
2223

2324
\end{document}

0 commit comments

Comments
 (0)