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 section on the web page #22

Open
bergos opened this issue Oct 27, 2023 · 5 comments
Open

Documentation section on the web page #22

bergos opened this issue Oct 27, 2023 · 5 comments

Comments

@bergos
Copy link
Member

bergos commented Oct 27, 2023

There is a documentation section on the page which is currently hidden because it doesn't contain any items. We shifted the discussion about which content it should contain in the PR discussion. I would like to open the discussion now on what scope and requirements we want to define for content in that section.

One question that I have in mind: Do we want library/framework specific documentation in there? For example, Comunica has a lot of documentation, RDF-Ext documentation is currently in progress. But they are also included in the library list. There are also pages like https://rdfjs.vercel.app/ which cover multiple libraries/frameworks.

@rubensworks
Copy link
Member

I don't have a strong opinion on this, but pages such as https://rdfjs.vercel.app/ covering multiple libs/frameworks can definitely fit in there IMO.

I'm not sure about lib-specific docs, since we could then have a link for every lib/framework. Would the READMEs of libs/framework fall under the docs definition in this case? Alternatively, we could add an optional docs entry for those libs/frameworks that have dedicated docs (aside from the README).

@bergos
Copy link
Member Author

bergos commented Oct 27, 2023

Yes, we could distinguish between simple READMEs and dedicated docs. The dedicated docs have some additional value and, therefore, should be listed there as well. But I also want to avoid that we end up with a copy of the library list.

I would keep all docs in the same section. Tags and a filter similar to the one in the libraries could be used to filter different kinds of docs.

@megoth
Copy link
Contributor

megoth commented Nov 3, 2023

I'll let you know once https://rdfjs.vercel.app/ has been released. I would be honored to have it listed on your site ^_^

@megoth
Copy link
Contributor

megoth commented Nov 7, 2023

Hey, https://rdfjs.vercel.app/ is now released for the public, and if you want to add to your website I would be honored ^_^

@bergos
Copy link
Member Author

bergos commented Nov 13, 2023

@megoth Please create a PR. Just copy one of the library entries (@id pointing to your page, name, and description. You can skip implements) to the documentations section and adapt it.

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

No branches or pull requests

3 participants