Skip to content

update docs#3769

Merged
teovin merged 6 commits into
harvard-lil:developfrom
teovin:update-docs
Apr 28, 2026
Merged

update docs#3769
teovin merged 6 commits into
harvard-lil:developfrom
teovin:update-docs

Conversation

@teovin

@teovin teovin commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

This PR merges the developer.md and install.md files and makes a few corrections to wording, URLs, and commands.

@teovin teovin requested a review from cmsetzer April 22, 2026 20:29
@codecov

codecov Bot commented Apr 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.64%. Comparing base (60ead32) to head (c593f57).
⚠️ Report is 22 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3769   +/-   ##
========================================
  Coverage    69.64%   69.64%           
========================================
  Files           65       65           
  Lines         7980     7980           
========================================
  Hits          5558     5558           
  Misses        2422     2422           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@cmsetzer cmsetzer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the editing! This looks like a step forward. A couple other thoughts:

  • Can we merge install.md and developer.md into one doc? I get confused about which one to read for instructions when I have to rebuild Perma.

  • While we're cleaning up the docs, can we standardize the Markdown code blocks? These docs currently use a mix of:

    ## Single backticks on own line:
    
    `d pytest`
    
    ## Indent with CLI prompt:
    
        $ docker compose up -d
    
    ## Fenced code blocks:
    
    ```sh
    d invoke lock --args "--upgrade-package package_name"
    ```

    My opinion: we should always use fenced blocks for non-inline code examples. What do you think?

Comment thread developer.md Outdated
@teovin

teovin commented Apr 28, 2026

Copy link
Copy Markdown
Contributor Author

@cmsetzer I merged the two mds and also standardized the non-inline code blocks and Flake8. Let me know if there is anything else, otherwise, I will merge this.

@cmsetzer

Copy link
Copy Markdown
Contributor

@teovin Looks good to me, thanks for working on this!

@teovin teovin merged commit 59fa9a4 into harvard-lil:develop Apr 28, 2026
2 checks passed
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.

2 participants