iotaledger / iota-wiki Goto Github PK
View Code? Open in Web Editor NEWIOTA Wiki
Home Page: https://wiki.iota.org
License: Other
IOTA Wiki
Home Page: https://wiki.iota.org
License: Other
Is your feature request related to a problem? Please describe.
In order to describe mathematical problems (especially in reserach posts and specifications), the wiki needs support for math notation.
Describe the solution you'd like
Mathjax
Describe alternatives you've considered
Briefly described in the linked issue from Docusaurus
Additional context
There has been previous discussion about this topic at Docusaurus with a few solutions assessed and a working solution seemingly identified:
facebook/docusaurus#2078
DEVELOP/Getting Started/Send a First Message
Describe the solution you'd like
I would like a section to be added that gives an introduction to the community eco-system in the IOTA wiki section community
Additional context
To provide an overview of the IF supported community developments that exist within the IOTA ecosystem.
PARTICIPATE/Support the Network/Run a Node
Explain the content strategy/philosophy, so the contributors know how we want the content to be provided. Implement an explanation for the in-page editor.
LEARN/Networks/IOTA 1.5 - Chrysalis
LEARN/Networks/DevNets
LEARN/About IOTA/Why is IOTA Feeless?
The ground we are covering with the Wiki is vast and listing all kinds of different topics in standard dropdown menus to navigate them is starting to get confusing for readers.
To allow us to categorize and group these topics more clearly, we've opted for a mega menu component containing a grid like layout, instead of using linear dropdown lists.
The mega menu dropdown should probably have the following design features:
DEVELOP/Exchange Integration/Guide
May be worth moving our test and reference materials to a new folder called docs-ref and keeping the main docs folder clean as this is the primary reference folder for docosaurus to populate the wiki.
LEARN/IOTA Token/Buying IOTA
Rewrite footer menus for the new categories. Using main as headers and sub categories as menu items.
Subcategories items to link to the top page in each of the respective subcategory menus in the sidebar.js file
PARTICIPATE/The Community/Social Media
Is your feature request related to a problem? Please describe.
We are still displaying old menu items and navbar menu items.
Describe the solution you'd like
Update to new navbar items and implement new sidebar menus for the individual sections:
LEARN, USE, PARTICIPATE, DEVELOP
USE/Utilities/Tangle Explorer
LEARN/About IOTA/An Introduction to IOTA
LEARN/About IOTA/Energy efficiency
And a general question for the wiki team - is there a plan to also extend the wikipedia.org pages?
For example:
Thanks for doing this! ❤️
USE/Use cases/Digital Assets
The new assets folder is visible in the main wiki sidebar menu, need to figure out a way to hide it from auto generatiing in the docosaurus sidebar.
Setup a dev branch for main pull requests and testing.
It should be the light mode globe that gets displayed.
LEARN/Wallets/What is a Wallet?
USE/Utilities/Visualizer
As discussed a separate page to navigate content by topic would be a great addition. This would also allow to implement "popular topics" in the landing page header more easily as this would just link to the specific topic in the topics page.
The idea is to use the keywords
of the frontmatter to automatically index topics during build and fill the topic page with cards for each topic, containing links to the content related to that topic.
The popular topics section on the landing page can be implemented as a React component which is configurable from the Docusaurus config file. So initially we can configure the popular topics manually. At a later stage we could look into how to automate this.
Started working on that already. Link archives pages can be found in the "docs-ref" section. Continue to collect links to original content, IF blogs, IF releases, Tech - updates, IF websites, IF Docs, IF - Githubs, IF Youtube content, HelloIota video content, helloIota blogs...
PARTICIPATE/Support the Network/Run a Node
Gonna work on a basic structure of the link content to have it categorised in: simple ELI5 style / experienced - dev style / high level - science style.
Hope we can get some input also from UX if this approach suits and what would be the best way to deliver that
LEARN/About IOTA/Roadmap to Decentralization
To allow a greater audience to contribute, the idea is to have an in-page editor that does not require any knowledge of markup languages or git, but transparently translates edited content to Markdown and integrates well with our current GitHub workflows.
Ideally the frontend has the rich text editor look and feel like Google Docs or Word. There are a few open questions:
LEARN/Resource materials/Glossary
It would be great if we could style the links of the content pages. Currently, we can't, since when we try to style the links of the content page, this styling gets applied to all the links on the page. Maybe the content page links need their own class?
Planned design: https://www.figma.com/file/rmb5zuItKmZH8OflJYnhSc/IOTA-wiki?node-id=1133%3A2482
ill update the png whenever new content gets picked up
Currently, we imagine the wiki being split into five sections: LEARN, BUILD, PARTICIPATE, PRODUCTS, RESEARCH. BUILD/Developer Docs could easily include a dozen software projects that have a dozen articles each. In total, the wiki would consist of dozens of subsections and hundreds of articles. That's a lot to navigate through.
My suggestion would be to have top-level sections listed in the topbar like the programming language picker in wc3schools. The user would switch between top-level sections by clicking on topbar. The sidebar would list TOC only of the current top-level section, but not the others.
This solution would split advanced developer's docu (BUILD section) from end user docu (all other sections). Having the rest four sections separated from each other in the same way means consistent UI as five buttons in the topbar would all do the same. It also reflects the structure: if we have "devs vs non-devs" switch, it would essentially bring a new layer to our document structure: DEV that only has BUILD section, and NON-DEV that has the other four.
Finally, I think this is not just about "dev vs non-dev". With RESEARCH section, it is also "academic vs non-academic", and with PARTICIPATE section, it is "engaged user vs casual user". I do not see that we need to separate docs for devs more than docs for any other major user group.
USE/Smart Contract/Programable Contracts
USE/Use cases/Data Confidence
USE/Utilities/IOTA IPFS
The discussion is how best to implement the developer documents into the wiki without overwhelming the sidebar navigation.
The core sidebar menu represents the low-level content for the wiki to include introductions, outline, features, basic guides, and other information. Within these pages in-page links and additional resource links can be added to guide the user to more high level content.
The issue we have is the amount of developer documentation is substantial enough that to include it in the current sidebar would present a navigation nightmare.
Suggestions
It has been suggested to keep the current sidebar as is, but to add a top bar/tab function that can enable a second sidebar which will contain a high level menu that can guide users through developer documentation, repos, and more tech heavy content.
This menu would utilise developer documentation in their current state, pulling them from their respective repos
LEARN/About IOTA/Data Transfer
Maybe we should create an assets folder for storing all 'in wiki' assets. It would be primarily for storing images, but also sub-folders for other content such as pdfs or other assets we may need in the future. It would also make it easier for contributors to add their assets if they need to as well.
LEARN/About IOTA/Value Transfer
Also work in progress of the content team...
Adam and myself will start on that step by step. Trying to use available source content and kind of extract the best possible overview. Find a suitable language approach that is not to complicated but exact enough to deliver information on point.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.