Skip to content

Conversation

@lauraporta
Copy link
Member

@lauraporta lauraporta commented Oct 6, 2025

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
Add logo, illustrations, improve description in the readme and homepage.

Note that after merging this PR documentation still needs major improvements. This is meant to be only for the homepage.

What does this PR do?
Adds figures, edits docs/source/ files and README.md

References

#27

How has this PR been tested?

Local build of website

Is this a breaking change?

No

Does this PR require an update to the documentation?

No

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@lauraporta lauraporta marked this pull request as ready for review October 7, 2025 17:38
@lauraporta lauraporta linked an issue Oct 7, 2025 that may be closed by this pull request
@lauraporta lauraporta requested a review from adamltyson October 8, 2025 09:23
Copy link
Collaborator

@sumiya-kuroda sumiya-kuroda left a comment

Choose a reason for hiding this comment

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

I think the link to CASCADE can be the one to the original repo
Sorry I was looking at the outdated commtit! LGTM!

Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

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

Looks nice, just a few small comments.

@lauraporta lauraporta moved this to Todo in photon-mosaic Oct 10, 2025
@lauraporta lauraporta moved this from Todo to Waiting for review in photon-mosaic Oct 10, 2025
@lauraporta
Copy link
Member Author

@adamltyson thanks for the comments. I've edited the illustration and expanded the explanations in the body. Let me know if it reads better to you now. I'll merge then.

@adamltyson
Copy link
Member

Looks good, only two final comments:

  • The colon in the bullet points are a bit strange
  • I would also link to the issues etc in the final sentance. The current link implies that the contributing guide has something to do with raising issues.

@lauraporta
Copy link
Member Author

lauraporta commented Oct 13, 2025

I like the colon in the bullet point 😅
I brought back the last sentence with a link to the issues and also the project board 😀
Merging as the tests are completed

@adamltyson
Copy link
Member

I like the colon in the bullet point 😅

It doesn't make sense though!

@lauraporta
Copy link
Member Author

@adamltyson I've made the suggested edits on formatting and contributing guidelines

@adamltyson adamltyson self-requested a review October 20, 2025 15:39
Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

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

Very nice. LGTM!

@adamltyson
Copy link
Member

Random point - if the neuropil subtraction from the allenSDK is adopted (as per the "Planned additions" section), it will need to be vendored as that package isn't maintained anymore.

@lauraporta
Copy link
Member Author

@adamltyson yes correct that's the plan!

@lauraporta lauraporta merged commit 1602f84 into main Oct 20, 2025
19 checks passed
@github-project-automation github-project-automation bot moved this from Changes requested to Done in photon-mosaic Oct 20, 2025
@adamltyson adamltyson deleted the improve-docs branch October 20, 2025 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Include nice graphics in readme and docs

3 participants