Skip to content

Conversation

@macSands
Copy link
Collaborator

Add first pages for new dissMapR and invasiMap R packages in development. Software repositories 'https://b-cubed-eu.github.io/dissmapr/' and 'https://b-cubed-eu.github.io/invasimapr' still to be created, so links won't work yet. With the new 'Astro + Starlight project' structure, I'm not sure where to update navigation tab.

Add first pages for new dissMapR and invasiMap R packages
@macSands macSands added the content Suggestions for content label Jan 31, 2025
@peterdesmet
Copy link
Contributor

Thanks @macSands!

I see you took inspiration from the gcube page, which makes sense. We'll change that up a bit though and include the external tutorials directly into the website. Here's how it will look:

  • A directory src/content/docs/software/dissmapr/
  • One file for each tutorial, e.g. metric-computation.md
  • Those files will be copied/generated from the source files in the dissmapr repository, by a function @sannegovaert will make.
  • We'll periodically rerun the function for all external tutorials, so we catch updates.

It's very good for us to know that the dissmapr and invasiMap packages and related tutorials are coming, but given that 1) we'll change the way we're adding them to the website (semi-automatically) and 2) they're currently not there yet, I'm going to keep this pull request in draft form until we have concrete files to parse.

FYI: the navigation is maintained here:

{
label: 'Software',
// autogenerate: { directory: 'software' },
items: [
'software/gbif-api',
'software/gcube'
],
collapsed: true,
},

Right now the software tutorials are added manually to the navigation, but after the switch we'll set that to autogenerate.

@peterdesmet peterdesmet marked this pull request as draft January 31, 2025 09:00
@peterdesmet peterdesmet requested review from sannegovaert and removed request for mtrekels January 31, 2025 09:01
@sannegovaert
Copy link
Member

I noticed the repositories are created, so I started to add dissmapr to the documentation website.

We read each .Rmd file and produce a .md file and figures that are added to the website.

However, our method does not work here because the Rmd files use an external .Rmd file.
{r child-2, child = "_common.Rmd"}

Warning in file(con, "r") :
  cannot open file 'C:/Users/SANNE_~1/AppData/Local/Temp/RtmpMV10n6/rmd_file/_common.Rmd': No such file or directory

@peterdesmet peterdesmet added this to the 1.0 milestone Sep 17, 2025
@sannegovaert
Copy link
Member

I noticed the repositories are created, so I started to add dissmapr to the documentation website.

We read each .Rmd file and produce a .md file and figures that are added to the website.

However, our method does not work here because the Rmd files use an external .Rmd file. {r child-2, child = "_common.Rmd"}

Warning in file(con, "r") :
  cannot open file 'C:/Users/SANNE_~1/AppData/Local/Temp/RtmpMV10n6/rmd_file/_common.Rmd': No such file or directory

Hi @macSands: Would it be possible to not use external files in your .Rmd so I can add your documentation to the website?

@sannegovaert
Copy link
Member

Ping @macSands

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

Labels

content Suggestions for content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants