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

Consider whether to move content from the readme to either the Extension Explorer or the standard documentation #41

Open
duncandewhurst opened this issue Oct 8, 2021 · 2 comments
Assignees

Comments

@duncandewhurst
Copy link
Contributor

From open-contracting/extension-explorer#47

In addition to #37, we should consider whether to move the other content.

Once done, we might need to update the content in the Extension Explorer that refers to this template.

@jpmckinney
Copy link
Member

More detail from the linked issue:

Decide whether to move content from the extension template to either the explorer or the standard documentation. This content might be split into multiple pages.

If moved, we can replace the extension template readme with sample headings and expand on what makes good documentation.

I think the last point might be a good motivation to move the content, as most third-party readmes are low quality.

@duncandewhurst
Copy link
Contributor Author

I agree that it makes sense to move everything but Getting started to the extension explorer documentation.

I've prepared a draft update to the publisher guidance to do that.

@jpmckinney do you want to review the draft before I update the HTML templates in open-contracting/extension-explorer#84? I've saved a comparison so that you can see what changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

No branches or pull requests

2 participants