Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Discussion to possibly restructure MAAP Docs #465

Open
smk0033 opened this issue Dec 11, 2024 · 2 comments
Open

Discussion to possibly restructure MAAP Docs #465

smk0033 opened this issue Dec 11, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@smk0033
Copy link
Contributor

smk0033 commented Dec 11, 2024

Creating more of a long-term ticket for discussion here. As we've been creating R Docs, organization of our docs have come up. Our docs are written in Python, but we are working through writing R-equivalents. For the time being, we are adding a separate R section under "Technical Tutorials" as this will probably be easier for the user to find what they're looking for.

As more R docs come out, we've thought about adding cells with the R equivalent in the existing Python notebooks. (For @smk0033 to do: test magic %%R in Python notebooks within the R workspace).

Opening this ticket to further discussion on the organization of our Docs.

cc: @grallewellyn @wildintellect @rtapella @zacdezgeo

@smk0033 smk0033 added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 11, 2024
@rtapella
Copy link
Collaborator

  • how do you expect someone to use the docs? e.g.
    • use the doc as a tutorial and walk thru cell-by-cell
    • use the doc as a template to copy and edit
    • ?
  • do you expect that you'll need to update the Python and R versions at the same time?
  • Is there a lot of overlapping content (e.g. paragraph descriptions) that are identical for both versions?

@grallewellyn
Copy link
Contributor

It might make the docs convoluted to have the R version next to the Python version

Is R that popular amongst our users that it is worth doing this? Or is it better to keep R in a separate section?

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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants