Giter Site home page Giter Site logo

iota-wiki's Issues

Add support for Mathjax

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

Add new topic eco-system to community section of wiki

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.

Update Fonts and fix main text color

Font Style of Side nav
Inter for subheaders (not metropolis)

Font Color:
Body text should be white/black and the secondary text a bit greyer/lighter (inversion from how it currently is).

Bildschirmfoto 2021-08-17 um 09 37 15

Content contribution guide:

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.

Replace dropdown lists with mega menus

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:

  • The menu should be responsive just like standard dropdowns are currently. On desktop it will expand all categories and layout all items in a grid like layout. On mobile it will turn into a linear list of items with collapsing categories.
  • The menu layout should consist of columns.
  • Each column contains one or more items and/or categories.
  • Each category contains multiple items.
  • Items have a label and optionally a sublabel and/or an icon.
  • The menu should be configurable from the Docusaurus configuration file.

Restructure docs

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.

Update footer menu

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

Update to new nav bar & integrate sidebar.js menus

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

Active State not working correctly

Describe the bug
This is the normal Menu, without an active state:
Bildschirmfoto 2021-05-27 um 13 43 44

If i click on a page, there should be just one menuitem selected with primary color, this is how it looks now:
Bildschirmfoto 2021-05-27 um 13 43 42

Expected behavior
Just the current menu item should have an active tag.

Hide the assets folder in sidebar

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.

Add a topics page where content is listed by topic.

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.

Research content links and resources

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...

Blog posts always display one min read

In the Blog section, I think posts are always being automatically labelled as "One min read" because we're using excerpts but the wiki thinks they're full posts. Perhaps we should remove the estimate, given that it's always gonna show 1 min. Thoughts?

image

Implement an in-page rich text editor for non-dev contributions.

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:

  • Do we want to be able to save our progress locally, to continue at a later time?
  • Do we want to allow editing multiple files at the same time? A topic might live at different locations in different forms. Topics might be interrelated.
  • If so, how do we present these files? Using tabs in the page or utilize browser tabs?
  • Do we want contributors to identify themselves, for example to track contributions and to be able to notify them about requests for updates or changes before their changes are accepted?

Navigation through the wiki.

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.

Sidebar menus and Dev Docs Integrations.

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

Add wiki docs assets folder

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.

create the content of the pages. Content taken from available sources combined and streamlined as an topic overview approach. that describes the topic broadly but also answers the most important things already. Add linking to external sources to dive deeper into the topic

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.