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

[Docu]: Adjust Documentation and maybe add a language pls (?) #326

Open
1 of 2 tasks
Jackson98Tomphson opened this issue Dec 13, 2023 · 1 comment
Open
1 of 2 tasks
Assignees

Comments

@Jackson98Tomphson
Copy link
Contributor

What are we changing or adding?

  • Repository
  • Wiki

Location

README Files and documentation on the obsidian app

The issue is...

🇬🇧:

Documentation and Support:

I've reviewed the plugin, very well done, and I have some suggestions to improve the accessibility of the documentation for newcomers.

🇮🇹:

Documentazione e Supporto:

Ho guardato il plug-in, molto ben fatto, e avrei qualche suggerimento per migliorare la fruizione della documentazione per i nuovi arrivati

Suggestions?

🇬🇧:

  1. Clarity in the numbering of subfolders for campaign elements. Unfortunately, there is no clear guidance in the documentation, and often one has to resort to trial and error in creating them to understand which ones are available and where they are in the folder tree.
  2. Given the frequent use of the "reload without saving" command to reset the reloading of elements loaded from the front-end, I would suggest including in the documentation and README a section emphasizing the importance of using this command (and any versions for IOS, Linux, and Windows).
  3. Reports for each patch of hotfixes, not just updated documentation, when the plugin is updated.

🇮🇹:

  1. Chiarezza nella numerazione delle sotto-cartelle degli elementi di una campagna, non vi è una traccia chiara nella documentazione purtroppo e spesso si deve andare prima a tentativi di creazione per capire quali sono disponibili e dove nell'albero di cartelle.
  2. Visto l'utilizzo frequente del comando "ricarica senza salvare" per reimpostare il reloading degli elementi caricati dal front-end, suggerirei di mettere proprio nella documentazione e nel read-me la sezione in cui si ribadisce l'importanza dell'utilizzo di questo comando (e le eventuali versioni per IOS, Linux e Windows).
  3. Report ad ogni patch degli hot fixes, non della documentazione aggiornata e basta, quando viene aggiornato il plug-in.

Anything else?

🇬🇧:
I would suggest an Italian version of the README documentation for a better understanding for Italian Masters and programmers and also for a sense of national pride 🤣. If needed, I volunteer to draft the initial version.
🇮🇹:
Suggerirei una Versione italiana della documentazione del README per uno spirito sia di miglior comprensione per i Master e programmatori italiani che per puro spirito di patria 🤣, nel caso servisse mi offro volontario per la prima bozza.

@Jackson98Tomphson Jackson98Tomphson changed the title [Docu]: [Docu]: Adjust Documentation and maybe add a language pls (?) Dec 13, 2023
@Jackson98Tomphson
Copy link
Contributor Author

🇬🇧:
I've implemented the Italian version for both the README.md and the front-end interface. Now, I proceed with the pull for the other proposed sections.
🇮🇹:
Ho implementato la versione italiana sia del README.md sia dell'interfaccia front-end. Ora procedo con la pull delle altre parti proposte.

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

No branches or pull requests

2 participants