GithubHelp home page GithubHelp logo

alvarlagerlof / neurodiversity Goto Github PK

View Code? Open in Web Editor NEW
42.0 5.0 11.0 9.48 MB

πŸ“– Website educating the public about neurodiversity

Home Page: https://neurodiversity.wiki

License: MIT License

JavaScript 4.56% CSS 0.54% TypeScript 44.85% MDX 50.05%
neurodiversity tool

neurodiversity's Introduction

Hello folks!

My name is Alvar LagerlΓΆf and I'm a he/him from Stockholm, Sweden. I enjoy making software and designing things. You can find more from me on my Twitter, LinkedIn or my website.

Thank you to the folks who sponsor my work on GitHub!

neurodiversity's People

Contributors

alvarlagerlof avatar dependabot[bot] avatar jtorreggiani avatar june7001 avatar renovate[bot] avatar vilhelmprytz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

neurodiversity's Issues

Figure out a release/editorial process

Currently, the website gets updated publicly whenever there is a push to main. This is not ideal and risky.

For content, it might include these steps

  1. Someone fact checks it
  2. Someone proofreads it
  3. The ready text could be approved by someone/multiple someones
  4. Merged to master

New code is submitted as a pull request

  1. Tests are ran
  2. The code is reviewed
  3. The ready code could be approved by someone/multiple someones
  4. We may also use branch protection rules to enforce parts of this process.

Localization?

In the long-term, we might want to translate pages to different languages and show the right one based on device language. I can do translations to Swedish. But more languages would be better.

Card links are not accessible

So I've recently read that if a link does not immediately have a text tag inside of it it's not going to sound right in screen readers.

Currently, the links on the start page pointing to subpages using LinkGrid.Item contain a h3 and a p.

The a should probably be inside the h3 according to this. This presents an issue.

We want the whole card to be clickable, but we want the link around the title. I've read an article saying that the correct way ro approach this to capture clicks on the card, and then trigger a click on the link. Then you solve both issues.

Optimize SEO

Figure out what is most important in terms of search ranking, and what shows up when linking, and implement that.

Screenshot 2021-08-26 at 01 03 08

Screenshot 2021-08-26 at 01 03 23

Another site I manage is at 21% CTR so I think we can do better

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: .github/renovate.json
Error type: Invalid JSON (parsing failed)
Message: Syntax error: expecting String near } ] }

Sharing links to a playlist of pages

Let's say you've got a friend/relative who is unaware of your conditions. Instead of sending the multiple pages in a row, what if you could send then a link with all of the right pages included? What if you could also add a comment for each page?

image
image

Finalize about text on start page

The text in "Why?" is perhaps the most important in the whole project. We should make sure that it reads as easily as possible and clearly communicates our goals. Maybe a bit of backstory including that the project started as a page just about OCD too?

Allow sending anonymous feedback

Perhaps there should be a way to send feedback for each page. It is important that we ensure that as many people as possible feel represented by out content. We could start with a simple Google form.

In addition, we may be able to highlight personal experiences that people share (not through the feedback above). Like testimonials.

Branch naming guidelines

So far, I've just added branches with pretty much any name. But I think we should prefix them. Maybe something like this:

  • content/draft-{page}: For new pages
  • content/{page}-{change}: For content changes (spelling, fact checking, more content/sections)
  • feature/{change}: For new features/improvements
  • fix/{change}: For fixes

Feedback wanted

Local support groups

We might have some sort of section at the bottom of each page where the visitor inputs their city and the website shows a list of supports group in that area

readme typos

There are a couple typos in the readme.
"It's also common to only focus on one conditon, even though knowledge about even though knowledge about most of them is lacking."

I'm something of a proofreader/copy editor and aspiring dev, but I tend to not offer fixes because I don't want to be perceived as "nit-picky." However, with a project such as this, where I have a personally vested interest (bipolar 1, schizoaffective, treatment resistant depression, social anxiety dis, etc) in its success and presentation in the best possible light, I don't think I'm being ocd or nit-picky; just trying to help in whatever way I feel I can. Code contributions can come later, if ever required, but what I can do immediately is scour the copy as a proofreader, and begin making the edits myself as opposed to pointing things out but not being proactive in rectifying what I find. If that would be considered useful, great. If not, no worries. Thanks for the project and all your efforts Alvar. =)

Gene

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.