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

Creation of Wiki page #63

Open
hasecilu opened this issue Mar 16, 2024 · 7 comments
Open

Creation of Wiki page #63

hasecilu opened this issue Mar 16, 2024 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@hasecilu
Copy link
Contributor

hasecilu commented Mar 16, 2024

I think would be nice to document the features of this addon on the FreeCAD Wiki.

Some days ago I updated the PieMenu entry here: https://wiki.freecad.org/External_workbenches but since there is no Wiki page it redirect to this repo.

As of now I think the content would be the README contents and some documentation done on the forum. I can create the Wiki page but I think you should say how to organize the content of it.

I think it could be possible to create a button (maybe in the bottom-right corner that says "Documentation" and it trigger FreeCAD to open the wiki page (inside FreeCAD), that would be helpful for users.

@Grubuntu
Copy link
Owner

A great idea.

I'll add a button to the documentation and someone can create the wiki page, or I'll do it.
Thanks

@Grubuntu Grubuntu added the documentation Improvements or additions to documentation label Mar 16, 2024
@hasecilu
Copy link
Contributor Author

I was thinking on adding:

  • Introduction with a picture of a PieMenu
  • Installation
  • Usage, with the main tabs
  • At the end optional: references and links

@hasecilu
Copy link
Contributor Author

This is the initial skeleton, if you have Wiki access you can finish it else you can give the media you prefer to use.
https://wiki.freecad.org/PieMenu_Workbench

@Grubuntu
Copy link
Owner

Thank you very much for your work

I don't have the rights to edit the wiki at the moment (I'll make the request). Feel free to take the initiative of inserting PieMenu screenshots into the wiki that you think are suitable, if you like. PieMenu is a team effort, so you can add your own personal touch.

hasecilu added a commit to hasecilu/PieMenu-Improved that referenced this issue Mar 21, 2024
The Help module implemented a system to manage the documentation settings as
the displayed language of the Wiki page or if it will be using online page,
downloaded html, downloaded md, etc or if it will open inside or outside
FreeCAD.

Read: `FreeCAD/src/Mod/Help/Help.py`

Related Grubuntu#63
hasecilu added a commit to hasecilu/PieMenu-Improved that referenced this issue Mar 21, 2024
The Help module implemented a system to manage the documentation settings as
the displayed language of the Wiki page or if it will be using online page,
downloaded html, downloaded md, etc or if it will open inside or outside
FreeCAD.

Read: `FreeCAD/src/Mod/Help/Help.py`

Related Grubuntu#63
@hasecilu
Copy link
Contributor Author

I made some progress but there is still missing the context example and the advanced settings.

@dzid26
Copy link
Contributor

dzid26 commented Mar 27, 2024

I made some progress but there is still missing the context example and the advanced settings.

What does Pie menu has to do with workbenches? I don't see the Pie Workbench.
image
Maybe it is possible to remove workbench references from the wiki page?

@hasecilu
Copy link
Contributor Author

Maybe, on the Addon Manager it falls under the Workbench group, maybe we need another group like "accesories"

image

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
Projects
None yet
Development

No branches or pull requests

3 participants