Comments (7)
Sure, I'll start it in few days. And will update you with the progress.
from quark.
I'm also wondering if we should keep documentation version wise. And if there is any small change then should we maintain the whole copy for another version or just the change?
It'll be little tricky to implement but can save a lot of space. In addition, it can also compare multiple versions for changes.
from quark.
Yes, for different versions of the same documentation, we must store only the difference. This will improve the setup time and will result in great features like comparing different versions, analysing progress of various technologies and others. ๐
For most basic users, the latest version of a documentation should address the majority of the queries. Different versions will be useful for advanced or experienced users. With the development of additional features, it will be of interest to all users. ๐
You may, initially, work on integrating the latest (or any one) version of a particular documentation. ๐
Once done, we can work on the feature of storing different versions as a separate feature. This will be globally applicable as we can use the same structure for the documentations, code data-store and other future data-related feature. โจ
from quark.
Hi Amit, Welcome to our OpenGenus community ๐จโ๐ฉโ๐งโ๐ฆ
Yes, providing documentation offline will be a great feature. ๐
One possible easy and a scalable path towards solving this is to crawl an online documentation recursively and save it as a text document or a single html file (possible through existing modules).
After this, the task is to integrate with our extension which will provide the existing features to be used with any API documentation ๐ .
You can develop the script in any language and focus on one particular API documentation (such as Java) at the moment. After this, we can work on this to make it more effective and extensible to other documentations.
Feel free to get in touch regarding anything. Keep us updated on your progress. ๐
from quark.
I've just checked and found that devdocs is already open source and works offline. So I believe there is no need to create another repo.
Going further, I've created a collection for such tools.
from quark.
Okay ๐
Our approach towards solving this problem is more general and goes beyond documentation.
If anyone wants to work on this feature, free feel to let us know and go for it. ๐
from quark.
I believe you mean version difference. What should be the end result in that case? As the process will be automated, what we can show is just text difference. We can't actually say which api is added, removed, or updated.
let me know what do you think.
from quark.
Related Issues (20)
- Dynamically Refresh Bookmarks HOT 1
- Display Number of Total Saved Favourites HOT 1
- Help modal is not responsive
- Record time spent on various sites HOT 3
- Add Offline games to Quark HOT 2
- Changing links to relative paths instead of heading slash
- Wrong words detected in background HOT 1
- Auto Suggestions for the Search Bar HOT 1
- Add 2048 game HOT 1
- UI Improvement
- ไฝ ๅฅฝ HOT 1
- improper loading of logo and buttons when run quark locally HOT 1
- Add T-Rex Color Change HOT 1
- Making it a firefox extension HOT 1
- Back button on feature pages
- Search Engine Triggers on random clicks.
- Offline-the-page, Plugin for Obsidian.md
- Mutaz Awad HOT 1
- Offline Dictonary
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from quark.