feat(website): Metadata documentation for generated fields#6259
feat(website): Metadata documentation for generated fields#6259
Conversation
…d made docs have w-full
|
Claude finished @tombch's task in 3m 4s —— View job Code Review
Good addition overall — the tab structure, search bar, and URL-addressable field links are all solid UX improvements. A few issues worth addressing before merge: Bug (inline comment on line 61): SSR safety (inline comment on line 45): Reading Performance (inline comments on lines 53 and 134–138):
Minor (inline comment on config.ts line 71): The No tests — the checklist item is unchecked, which is fine for a docs/UI feature, but worth noting that the hash-parsing logic in particular would benefit from a unit test given the edge cases. |
anna-parker
left a comment
There was a problem hiding this comment.
Already looks great here and on the PPX as well - it might be good to already add the descriptions for the INSDC fields here as well
| import type { TopNavigationItems } from './navigationItems.ts'; | ||
|
|
||
| export const extraStaticTopNavigationItems = []; | ||
| export const extraStaticTopNavigationItems: TopNavigationItems = [ |
There was a problem hiding this comment.
I guess as this will now lead all instances running loculus to have a docs link with Fill this in with documentation for your loculus instance. maybe we dont want to add a link to the docs by default to the top? @theosanderson do you have thoughts?
| }> = ({ organisms }) => { | ||
| const [selectedOrganismKey, setSelectedOrganismKey] = useState<string>(''); | ||
|
|
||
| // Set the initial selected organism based on the URL parameter |
There was a problem hiding this comment.
not a react expert but my understanding is we added popstate to get ensure that the state of the page and the URL are kept in sync when a user would navigate forwards and backwards, could this now get out of sync?
This PR does the following:
kubernetes/loculus/templates/_common-metadata.tpl.resolves #
Screenshot
PR Checklist
🚀 Preview: https://generated-field-docs.loculus.org