mathesar-foundation / mathesar-wiki Goto Github PK

Problem

Mathesar a lots of moving parts and it would be better if we have documentation that gives a bird's eye view of the codebase making it easier for someone new to the codebase

Proposed Solution

Django has good docs which addresses similar problem, we could build on top of that

I still find this practice weird and I don't fully understand the rationale. If it were me, I'd just use .ts all the time and never .d.ts. We should document this practice and a standard and explain the rationale.

Problem

Filters as of now don't have support for nesting and are flat, so confusion can arise if multiple logical operators are used on the same level.

Proposed Solution

We would need to mention the precedence order of the operators to specify why certain operators took priority over the other.

Additional Context

This issue came out of a matrix discussion

The contributing guidelines do not mention which GitHub development workflow to follow when starting to write code. This may create confusion for contributors who have previously contributed in other projects (different projects may follow different workflows).

Possible workflows include:

1. Create new branch in main repo. -> Make code changes in this branch -> PR
2. Create personal fork of main repo. -> Create new branch in the personal fork -> Make code changes in this branch -> PR

This information should be included to avoid confusion among new contributors.

We were able to get the about page translated into Japanese at the Code for Japan hackathon. It was added into the Japanese section of the wiki, but because there is no Japanese home page, there is no link to the about page and the top page/home page doesn't exist.

We need to clearly define what a data type is and what a Mathesar type is.

Related discussions:

• mathesar-foundation/mathesar#838
• mathesar-foundation/mathesar#843
• mathesar-foundation/mathesar#849

Problem

When a new Mathesar version is released we need to update the demo server and a few other internal servers. The process to update these servers is not documented in our wiki.

The spec authoring and review guidelines on the wiki are out of date: https://wiki.mathesar.org/design/process/review-guidelines, since we now use the wiki and pull requests for specs. We need to update the wiki to be in sync with our process.

I noticed a small typo in the word links. It's written as linka.

Notice the paragraph in sky-blue background.

• Relative vs absolute
• When to use aliases
• @mathesar-component-library vs @mathesar-component-library-dir
• When to add new code to a index.ts

We need a spec for for describing UX for importing data.

This will also solve redesigning the preview issue.

We need to create and flesh out all the pages that the new engineering wiki structure needs.