moja-global / moja_global_docs

Repository to host the moja global technical documentation
https://docs.moja.global/en/master/
Mozilla Public License 2.0
35 stars 67 forks source link

Documentation📄: Table for short forms. #202

Open sailorworks opened 2 years ago

sailorworks commented 2 years ago

What is the current documentation state?

The Full Lands Integration Tool (FLINT) is moja global’s flagship software. FLINT is a modular and highly flexible open-source software technology designed to meet the needs of governments, the private sector and other users in measuring, reporting and verifying (MRV) – or forecasting – greenhouse gas emissions and removals from forestry, agriculture and other land uses (AFOLU).

Where is this stated?

documentation

Why do you want to improve the statement?

While I was going through the documentation, I felt that there were many short forms and I had to constantly jump to that particular page where I found that short form for the first time. This can be helpful for those who are just starting to contribute.

Proposed Statement

What we can do here is make a table for short form with what they represent and show it on every page or at least link it somewhere in documentation .

Additional context.

No response

sailorworks commented 2 years ago

If this issue looks fine, please assign this issue to me.

meenaljain0303 commented 1 year ago

I can help with with issue

sailorworks commented 1 year ago

@meenaljain0303 what do you think we can do here, I tried searching if we can link these short form (anywhere in the doc) to the full forms in the document itself but there is no such syntax available in sphinx.

meenaljain0303 commented 1 year ago

We can hyperlink the short forms to their respective long forms, which will be provided at the end of the document!? If not that, we can mention their respective full forms in brackets at the end of every page as it can be referenced then and there. Will this work ?

sailorworks commented 1 year ago

Ohk then, I'll unassign myself now, go ahead with this issue, and maybe we can discuss it in the community_meeting tomorrow.

meenaljain0303 commented 1 year ago

Kindly assign it to me so that I can contribute