Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP Printable Handbook #126

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

WIP Printable Handbook #126

wants to merge 1 commit into from

Conversation

igaray
Copy link
Collaborator

@igaray igaray commented Nov 1, 2024

This PR involves several changes:

  • the content is reorganized:
    • Part I will include all content required regardless of role, skillset, or project: introduction, company culture, toolstack and dev env setup, technical foundations.
    • Part II will include the rest of the technical content and be organized into chapters by topic, to be read on demand, and will include content regardless of seniority, for both juniors and seniors.
  • An editing flow is introduced:
    • A makefile is introduced with several targets, intended to be run on a Mac with brew and docker installed. deps installes required dependencies, build will compile the HLP into its markdown and PDF versions.
    • the HLP contents are typeset in typst, and translated to markdown via pandoc.

@igaray igaray changed the title Makefile, typst, pandoc, mermaid builder Printable Handbook Nov 4, 2024
@igaray igaray changed the title Printable Handbook WIP Printable Handbook Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant