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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃殌 Feature: Documentation: Update 'Input Examples' for Software Templates #25375

Open
2 tasks done
rewixe opened this issue Jun 24, 2024 · 1 comment
Open
2 tasks done
Assignees
Labels
enhancement New feature or request

Comments

@rewixe
Copy link

rewixe commented Jun 24, 2024

馃敄 Feature description

I want to update the note to use admonitions and also to include a note making it more explicit that the functionality only works for remote files and not local files. I also want to mention that you can't nest files

馃帳 Context

As per discussion in this issue, I want to use the correct syntax for making a note, and also to add more information about this functionality which would address recurring questions regarding functionality, e.g. using local files, nesting files

鉁岋笍 Possible Implementation

The documentation should include:

  • The correct syntax for notes (admonitions)
  • A note regarding local files and nesting

馃憖 Have you spent some time to check if this feature request has been raised before?

  • I checked and didn't find similar issue

馃彚 Have you read the Code of Conduct?

Are you willing to submit PR?

Yes I am willing to submit a PR!

@rewixe rewixe added the enhancement New feature or request label Jun 24, 2024
@rewixe
Copy link
Author

rewixe commented Jun 24, 2024

Hi @awanlin, created this to address issues brought up in #25365. This can be assigned to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant