Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation📄: Table for short forms. #202

Open
sailorworks opened this issue Aug 16, 2022 · 6 comments
Open

Documentation📄: Table for short forms. #202

sailorworks opened this issue Aug 16, 2022 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sailorworks
Copy link
Contributor

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 sailorworks added the documentation Improvements or additions to documentation label Aug 16, 2022
@sailorworks
Copy link
Contributor Author

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

@meenaljain0303
Copy link

I can help with with issue

@sailorworks
Copy link
Contributor Author

@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
Copy link

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
Copy link
Contributor Author

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

@sailorworks sailorworks removed their assignment Jan 13, 2023
@meenaljain0303
Copy link

Kindly assign it to me so that I can contribute

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants