Documentation¶
← Project README · Guide index
This is the project-wide documentation router. Choose a topic below; each destination owns its detailed instructions. Folder READMEs provide local navigation rather than another copy of those instructions.
Start here¶
| Task | Starting point |
|---|---|
| Read published notes or browse course archives | Project README |
| Set up a local checkout | Installation |
| Write, build, or maintain notes | Guide index |
| Understand the shared source tree | LaTeX overview |
| Contribute or report a problem | Contributing |
Directory contents¶
| Area | Router or reference |
|---|---|
| Contributor guides | Guide index: setup, writing, class usage, and repository development |
| Shared LaTeX infrastructure | LaTeX router: class, components, fonts, tools, and examples |
| Components and isolated examples | Component router |
| Bundled fonts | Font router |
| English and Italian integration examples | Integration directories |
| Published editions | Release archive |
| Committed course history | Generated changelogs |
Source references¶
| Document | Owns |
|---|---|
| LATEX.md | Physical structure of latex/ and the purpose of its directories. |
| COMPONENTS.md | Component interfaces, dependencies, example design, and extension rules. |
| FONTS.md | Individual font files, LaTeX mappings, and font maintenance. |
| TOOLS.md | File-by-file Python tool index and links to each tool's workflow. |
| TESTS.md | Individual test explanations and test-running commands. |
Policies and agent guidance¶
| Topic | Document |
|---|---|
| Contribution workflow and academic integrity | Contributing |
| Community standards and conduct reporting | Code of Conduct |
| Private vulnerability reporting | Security |
| Project licensing and academic disclaimer | Project README · Academic disclaimer |
| Font attribution and license text | Font licences |
| Human review and AI disclosure | AI-assisted development |
| Repository rules and specialized agent workflows | AGENTS.md and its skill routing table |
Documentation assets¶
assets/ contains presentation files, not course material or compiled notes. For course-owned figures, use the course asset conventions.
| Asset | Used for |
|---|---|
unipd.png |
Project README image and website logo. |
notes/computer-engineering-notes-preview.png |
Notes preview in the project README. |
site.css |
Website presentation overrides, maintained through the site guide. |
Documentation site¶
Browse the website once Pages is enabled. Documentation site owns local builds, previews, public-file boundaries, PDF readers, and deployment instructions; the Markdown linked here is the website's source, not a second documentation set.