Skip to content

docs: community detection guide#844

Draft
BeaMarton13 wants to merge 69 commits into
igraph:developfrom
BeaMarton13:feat/community-detection-guide-docs
Draft

docs: community detection guide#844
BeaMarton13 wants to merge 69 commits into
igraph:developfrom
BeaMarton13:feat/community-detection-guide-docs

Conversation

@BeaMarton13

Copy link
Copy Markdown
Contributor

Copilot was used to assist with the generation of some functions and explanatory texts.

  • By submitting this pull request, I assign the copyright of my contribution to The igraph development team.

@szhorvat

szhorvat commented Aug 1, 2025

Copy link
Copy Markdown
Member

It's starting to look great!

Some tips:

  • Be sure to add necessary packages to the install and update steps of mkdocs.sh
  • Can we find a way to add a download button to the end of pages, to allow people to get the notebook?
  • Note that this is integrated into the doc pages, can we link directly to function docs? If this is easy, let's do it, if not, it's not worth spending time on.
  • Check the visual output and use only as many bullet points as looks good. I don't suggest trying to include notebook cells in bullet points. Just write explanations above cells without a bullet.

@szhorvat

szhorvat commented Aug 4, 2025

Copy link
Copy Markdown
Member

Be sure to add necessary packages to the install and update steps of mkdocs.sh

@BeaMarton13, please be sure to do this, otherwise the docs won't build, and we can't easily check them.

Comment thread doc/source/conf.py Outdated
Comment thread doc/source/conf.py Outdated
Comment thread doc/source/conf.py Outdated
Comment thread doc/source/index.rst Outdated
Comment thread scripts/mkdoc.sh Outdated
@ntamas

ntamas commented Oct 1, 2025

Copy link
Copy Markdown
Member

@szhorvat What's the status of this, can this be merged into develop?

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.

3 participants