question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Keep developer guides for projects updated

See original GitHub issue

Your use case

What would you like to do?

I would like to have the latest developer guides for the projects under matrix-org such as matrix-react-sdk which reflect the latest internal discussion. For example, I would like to have a style guide on usage of spacing variables in https://github.com/matrix-org/matrix-react-sdk#developer-guide with the graphic on https://github.com/matrix-org/matrix-react-sdk/pull/7456

Why would you like to do it?

I think that unlike Element, a software of vector-im, SDKs for Matrix should provide the latest, up-to-date documentation which reflects the latest internal discussion, because I think that publishing a guideline and keeping it updated helps outside developers to work on Matrix without being worried about the possibility that their works could be based on an obsolete spec, etc. Personally I feel it is not fair to tell a developer that his/her work is not based on the latest spec, even if it is not available to him/her.

How would you like to achieve it?

I would like to ask the developer team of Matrix to keep the developer guides of projects under matrix-org updated, for example, by requiring a PR to include documentation update at the same time if the change is related to the spec change or an internal discussion.

Have you considered any alternatives?

One of the other alternatives could make private internal rooms public (whether guests are allowed to send a message or not) to let them follow the discussion and spec change.

Additional context

No response

Issue Analytics

  • State:open
  • Created a year ago
  • Comments:5 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
t3chguycommented, Apr 11, 2022

Such doesn’t exist yet, and will likely not exist coherently until the Design team finishes Compound (UI kit) and we can start applying it to the codebase. Right now there isn’t much consistency.

0reactions
luixxiulcommented, Apr 11, 2022

Thanks for the reply. That is the kind of internal information I’ve been hoping for.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Developer Guides
Android Developers · Docs More. Platform Android Studio Google Play ... Documentation · Guides More. Overview UI Guide Reference Samples ...
Read more >
How To Maintain Open-Source Software Projects - DigitalOcean
This tutorial will take you through some tips for maintaining public repositories of open-source software. Being a leader of an open-source ...
Read more >
Quickstart guide for developing with projects (BETA)
Get started developing with HubSpot projects using this quick start guide.
Read more >
How to Manage Project Documentation Throughout Your Project
Using a project documentation tool, insights and lessons learned from one project can be transferred easily to new ones. This knowledge can help...
Read more >
A developer's guide to project management (PM), Part 1/2
If you're a developer, you have worked on a project. ... It helps you decide how to approach a new project.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found