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

Addition of new Offline Documentation #337

Merged
merged 1 commit into from
Jan 23, 2025

Conversation

Reqrefusion
Copy link
Member

If there was a mistake, Yorik made it because I copied it verbatim from the previous offline documentation. I'm adding this experimentally for now. It still appears as a repo of mine. I will add the token that makes the changes to FreeCAD when I switch it from personal token to app token.

@luzpaz luzpaz linked an issue Dec 16, 2024 that may be closed by this pull request
22 tasks
@luzpaz
Copy link
Collaborator

luzpaz commented Dec 16, 2024

Attention: This Repo is close to 1 GB in size and is constantly updated. Please use the addon manager with git if you want to keep it updated. Ayrıca dosyalar üzerinde değişiklik yapılamaz. Use the other Repo to make changes.

Ref: https://github.com/Reqrefusion/FreeCAD-Documentation-html?tab=readme-ov-file#gordian-knotfreecad-documentation-html

CC @chennes @yorikvanhavre

@yorikvanhavre
Copy link
Member

@Reqrefusion have you checked if is it usable from within FreeCAD? Using the help preferences?

@Reqrefusion
Copy link
Member Author

@Reqrefusion have you checked if is it usable from within FreeCAD? Using the help preferences?

Yes, it works that way. However, it is necessary to make changes in the help module.

ScreenRecorderProject1_711.mp4

I turned off the internet to record the video, by the way, you can be sure that it is offline. The change I made to the Help module was to convert ".md" to ".html". For now, I am not preparing a PR because there are question marks in my mind. I think it is necessary to completely remove MD support from the help module. So the other attempt needs to be completely shelved. This simplifies the code tremendously. What is your opinion on this, @yorikvanhavre . It is obvious that this system is much better than MD.

@yorikvanhavre
Copy link
Member

Well, you know my opinion on that...

@Reqrefusion
Copy link
Member Author

Well, you know my opinion on that...

No I don't know. It would be very scary if I knew. Because I would be able to read people's minds. I probably wouldn't be here, I think I'd be selling something or something. When you think about it, I wonder what use the ability to read minds can have? For example, can the brain get stuck in the language barrier while reading? Or people's thoughts are mostly meaningless, how can they be separated?

Anyway, there hasn't been any correspondence about this before, and if there was, I probably missed it.

@yorikvanhavre
Copy link
Member

No I don't know.

My opinion is that we should go the markdown path, and we should not remove markdown support in the help module.

Now, this has no impact on this PR, I guess... I'll merge it

@yorikvanhavre yorikvanhavre merged commit 9017e65 into FreeCAD:master Jan 23, 2025
1 check passed
@Reqrefusion
Copy link
Member Author

No I don't know.

My opinion is that we should go the markdown path, and we should not remove markdown support in the help module.

Now, this has no impact on this PR, I guess... I'll merge it

Markdown support in the help module is very makeshift. It seems ridiculous to me that a help module contains something like this. A system integrated into the aid module for Markdown can be added or QT can directly support it.

Nevertheless, what is here is not about them. It is very good that the most comprehensive solution for offline help is somehow involved. Maybe you've tried it, it's a very smooth experience.

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

Successfully merging this pull request may close these issues.

FreeCAD-Documentation-html
4 participants