Skip to content

Init Best Practice document for new terms - #466

Merged
kara-mela merged 2 commits into
pan-ontologies:masterfrom
kara-mela:ISS292-best-practice
Sep 29, 2026
Merged

kara-mela merged 2 commits into
pan-ontologies:masterfrom
kara-mela:ISS292-best-practice

Conversation

@kara-mela

Copy link
Copy Markdown
Collaborator

Motivation

The new structure of PaNET brings more possibilities, but also more challenges for creating a new term.
To help researchers and PaNET members adding new terms, we should provide a best practice document on our webpage.

Modification

An initial version of the Best Practice document has been added.
This also required to add some images and to update the css file as well as to link it in the navigation bar.

Result

Better guidance.

Related Issues

Closes #292

@eilmiv eilmiv left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I found some small typos and possible changes.

Comment thread docs/best_practice_new_term.html Outdated
Comment thread docs/best_practice_new_term.html Outdated
Comment thread docs/best_practice_new_term.html Outdated
Comment thread docs/best_practice_new_term.html Outdated
Motivation

The new structure of PaNET brings more possibilities, but also more
challenges for creating a new term.
To help researchers and PaNET members adding new terms, we should provide a
best practice document on our webpage.

Modification

An initial version of the Best Practice document has been added.
This also required to add some images and to update the css file as well as
to link it in the navigation bar.

Result

Better guidance.

@eilmiv eilmiv left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say it is good as it is. But I still found some minor typos.

Comment thread docs/best_practice_new_term.html Outdated
Comment thread docs/best_practice_new_term.html Outdated
Comment thread docs/best_practice_new_term.html Outdated
Comment thread docs/best_practice_new_term.html Outdated
Comment thread docs/best_practice_new_term.html Outdated
Comment thread docs/best_practice_new_term.html Outdated
Motivation

While working on the Best Practice document, I realized that some commands
in the css file were wrong and therefore effectless. By activating them,
I also realized that the headings were often too big and pompous.

Modification

Changed ".content-section h{1,2,3}" to "#scope-sidebar h{1,2,3}" to activate
the design.
Updated the layout.

Result

More balanced design.
@kara-mela
kara-mela merged commit d397767 into pan-ontologies:master Sep 29, 2026
4 of 5 checks passed
@kara-mela
kara-mela deleted the ISS292-best-practice branch September 29, 2026 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Creating a PaNET Best Practice document

2 participants