Skip to content

Conversation

@mfisher87
Copy link
Member

@mfisher87 mfisher87 commented Sep 10, 2025

Description

  • Front page
    • The front page of our docs is pretty wordy! Extract long-form content to overview section, replace with quick-to-read highlights on the front page. Add some 🔥 emojis.
    • Link to GeoJupyter website on docs front page
  • Overview section
    • Add page: "What is JupyterGIS?"
    • Move the "features" section from the user guide to the overview.
      • Move the "how-to setup up collaboration" instructions to a new how-tos section in the user guide. Cross-link.
  • Link to team compass in contributor guide

Future PR: Roadmap page in overview section

Checklist

  • PR has a descriptive title and content.
  • PR description contains references to any issues the PR resolves, e.g. Resolves #XXX.
  • PR has one of the labels: documentation, bug, enhancement, feature, maintenance
  • Checks are passing.
    Failing lint checks can be resolved with:
    • pre-commit run --all-files
    • jlpm run lint

📚 Documentation preview: https://jupytergis--921.org.readthedocs.build/en/921/
💡 JupyterLite preview: https://jupytergis--921.org.readthedocs.build/en/921/lite

@mfisher87 mfisher87 added the documentation Improvements or additions to documentation label Sep 10, 2025
@github-actions
Copy link
Contributor

Binder 👈 Launch a Binder on branch mfisher87/jupytergis/docs-overview-and-reorg

@github-actions
Copy link
Contributor

github-actions bot commented Sep 10, 2025

Integration tests report: appsharing.space

@mfisher87 mfisher87 force-pushed the docs-overview-and-reorg branch from 3154520 to 53127b2 Compare September 29, 2025 17:26
@mfisher87 mfisher87 changed the title Create new top-level "oveview" section in docs Create new top-level "overview" section in docs Sep 29, 2025
@mfisher87 mfisher87 marked this pull request as ready for review September 30, 2025 20:10
Copy link
Collaborator

@stefanv stefanv left a comment

Choose a reason for hiding this comment

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

This looks good overall! I left some minor feedback.

@mfisher87
Copy link
Member Author

mfisher87 commented Oct 14, 2025

@martinRenou @arjxn-py Any feedback on this? Would like to link folks here during JupyterCon :)

(@stefanv sorry for the delay on implementing changes from your feedback, I'll get to it soon)

Copy link
Member

@arjxn-py arjxn-py left a comment

Choose a reason for hiding this comment

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

Nice one @mfisher87
Really like the venn diagram you've added and all the changes looks good to me

@mfisher87 mfisher87 force-pushed the docs-overview-and-reorg branch from c5eec53 to 841c6fb Compare October 29, 2025 15:59
@mfisher87
Copy link
Member Author

@stefanv @arjxn-py sorry for the delay, does this look good to merge?

@mfisher87 mfisher87 changed the title Create new top-level "overview" section in docs Create new top-level "overview" section in docs, note lack of collab support in JLite Oct 29, 2025
@mfisher87 mfisher87 requested review from arjxn-py and stefanv October 29, 2025 17:27
Copy link
Member

@arjxn-py arjxn-py left a comment

Choose a reason for hiding this comment

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

Looks Good to merge to me! Thanks Matt :)

@mfisher87 mfisher87 merged commit 8158a24 into geojupyter:main Oct 30, 2025
15 checks passed
@mfisher87 mfisher87 deleted the docs-overview-and-reorg branch October 30, 2025 15:26
@mfisher87
Copy link
Member Author

Thanks for the reviews @arjxn-py @stefanv :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants