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

docs: add CHANGELOG.md, project breakdown in CONTRIBUTING.md #248

Merged
merged 3 commits into from
Feb 8, 2021

Conversation

lrlna
Copy link
Member

@lrlna lrlna commented Feb 8, 2021

Description

Adding a placeholder CHANGELOG.md with just information about the initial release.
Also copying some information over from docs' Contributing page. I think it will be useful for those who only stumble across the repo rather than the docs page.

@EverlastingBugstopper
Copy link
Contributor

bit worried about the duplication between CONTRIBUTING.md and docs/source/contributing.md, maybe we can utilize MDX to pull from the root of the repo when the docs are built?

@JakeDawkins
Copy link
Contributor

@EverlastingBugstopper I could imagine a set of work around build-time docs things. I'm not sure what all that would be now, but I think we could maybe lump something like that along with work to, for example, have a full api reference built from source

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.

3 participants