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.

Sign up for GitHub

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

Jump to bottom

📚 Create beBOP functional documentation #903

Open
Tirodem opened this issue Jan 4, 2024 · 6 comments
Open

📚 Create beBOP functional documentation #903

Tirodem opened this issue Jan 4, 2024 · 6 comments
Assignees
@Tirodem
Labels
1 - High documentation Improvements or additions to documentation Donator:Luxogood Donator:NPR For:Everyone Open release MVP

Comments

@Tirodem
Copy link
Contributor

Tirodem commented Jan 4, 2024

No description provided.

@Tirodem Tirodem added documentation Improvements or additions to documentation Open release MVP labels Jan 4, 2024
@Tirodem Tirodem self-assigned this Jan 4, 2024
@Tirodem
Copy link
Contributor Author

Tirodem commented Jan 4, 2024

@coyotte508 what would be the best way of writing documentation (in term of support) if we want it to be displayable from admin interface ?

@coyotte508
Copy link
Collaborator

Markdown

@Tirodem
Copy link
Contributor Author

Tirodem commented Jan 5, 2024

So, markdown files & required pictures in a dedicated folder on the repo ?

@coyotte508
Copy link
Collaborator

Yes when the repo is open source we can host the pictures on github in the repo

@Tirodem
Copy link
Contributor Author

Tirodem commented Feb 3, 2024

Three more questions before digging in because it'll be my focus next week :

  • in which path where should I put my .md files ?
  • how to I manage translation for them ?
  • should tooltip texts be in 1/ md files 2/ translation json 3/ specific translation json ?

@coyotte508
Copy link
Collaborator

For now docs/en/xxx.md and so on (will move it if needed)

@Tirodem Tirodem mentioned this issue Feb 3, 2024
Merged
Tirodem added a commit that referenced this issue Mar 14, 2024
@Tirodem
Bebop help infos / 📚 Create beBOP functional documentation #903 (#973)
4d75091
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Tirodem Tirodem

Labels
1 - High documentation Improvements or additions to documentation Donator:Luxogood Donator:NPR For:Everyone Open release MVP
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@coyotte508 @Tirodem